Autostart

GitHub npm crates.io

API Reference

Automatically launch your application at system startup.

Supported Platforms

• Windows
• Mac (via AppleScript or Launch Agent)
• Linux

Setup

Install the autostart plugin to get started.

Automatic

Use your project’s package manager to add the dependency:

npm

npm run tauri add autostart

yarn

yarn run tauri add autostart

pnpm

pnpm tauri add autostart

bun

bun tauri add autostart

cargo

cargo tauri add autostart

Manual

1. Run cargo add tauri-plugin-autostart to add the plugin to the project’s dependencies in Cargo.toml.

2. Modify lib.rs to initialize the plugin:

   lib.rs

   use tauri_plugin_autostart::MacosLauncher;
   
   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   fn run() {
       tauri::Builder::default()
           .plugin(tauri_plugin_autostart::init(MacosLauncher::LaunchAgent, Some(vec!["--flag1", "--flag2"]) /* arbitrary number of args to pass to your app */))
           .run(tauri::generate_context!())
           .expect("error while running tauri application");
   }

3. You can install the JavaScript Guest bindings using your preferred JavaScript package manager:

   npm

   npm install @tauri-apps/plugin-autostart

   yarn

   yarn add @tauri-apps/plugin-autostart

   pnpm

   pnpm add @tauri-apps/plugin-autostart

   bun

   bun add @tauri-apps/plugin-autostart

Usage

The autostart plugin is available in both JavaScript and Rust.

JavaScript

import { enable, isEnabled, disable } from '@tauri-apps/plugin-autostart';
// when using `"withGlobalTauri": true`, you may use
// const { enable, isEnabled, disable } = window.__TAURI_PLUGIN_AUTOSTART__;

// Enable autostart
await enable();
// Check enable state
console.log(`registered for autostart? ${await isEnabled()}`);
// Disable autostart
disable();

Rust

use tauri_plugin_autostart::MacosLauncher;
use tauri_plugin_autostart::ManagerExt;

#[cfg_attr(mobile, tauri::mobile_entry_point)]
fn run() {
    tauri::Builder::default()
        .plugin(tauri_plugin_autostart::init(
            MacosLauncher::LaunchAgent,
            Some(vec!["--flag1", "--flag2"]),
        ))
        .setup(|app| {
            // Get the autostart manager
            let autostart_manager = app.autolaunch();
            // Enable autostart
            let _ = autostart_manager.enable();
            // Check enable state
            println!("registered for autostart? {}", autostart_manager.is_enabled().unwrap());
            // Disable autostart
            let _ = autostart_manager.disable();
            Ok(())
        })
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

Permissions

By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your capabilities configuration to enable these.

See the Capabilities Overview for more information and the step by step guide to use plugin permissions.

src-tauri/capabilities/main.json

{
  "permissions": [
    ...,
    "autostart:allow-enable",
    "autostart:allow-disable",
    "autostart:allow-is-enabled"
  ]
}

Permission	Description
autostart:allow-disable	Enables the disable command without any pre-configured scope.
autostart:deny-disable	Denies the disable command without any pre-configured scope.
autostart:allow-enable	Enables the enable command without any pre-configured scope.
autostart:deny-enable	Denies the enable command without any pre-configured scope.
autostart:allow-is-enabled	Enables the is_enabled command without any pre-configured scope.
autostart:deny-is-enabled	Denies the is_enabled command without any pre-configured scope.