Autostart

GitHub npm crates.io

API Reference

Lancez automatiquement votre application au démarrage du système.

Plates-formes prises en charge

This plugin requires a Rust version of at least 1.77.2

Platform	Level	Notes
windows
linux
macos
android
ios

Configuration

Installez le plugin autostart pour commencer.

Automatique

Utilisez le gestionnaire de paquets de votre projet pour ajouter la dépendance :

npm

npm run tauri add autostart

yarn

yarn run tauri add autostart

pnpm

pnpm tauri add autostart

deno

deno task tauri add autostart

bun

bun tauri add autostart

cargo

cargo tauri add autostart

Manuel

1. Exécutez la commande suivante dans le dossier src-tauri pour ajouter le plugin aux dépendances du projet dans Cargo.toml :

   cargo add tauri-plugin-autostart --target 'cfg(any(target_os = "macos", windows, target_os = "linux"))'

2. Modifiez lib.rs pour initialiser le plugin :

   src-tauri/src/lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   pub fn run() {
       tauri::Builder::default()
           .setup(|app| {
               #[cfg(desktop)]
               app.handle().plugin(tauri_plugin_autostart::init(tauri_plugin_autostart::MacosLauncher::LaunchAgent, Some(vec!["--flag1", "--flag2"]) /* nombre arbitraire d'arguments à passer à votre application */));
               Ok(())
           })
           .run(tauri::generate_context!())
           .expect("error while running tauri application");
   }

3. Vous pouvez installer les liaisons JavaScript Guest en utilisant votre gestionnaire de paquets JavaScript préféré :

   npm

   npm install @tauri-apps/plugin-autostart

   yarn

   yarn add @tauri-apps/plugin-autostart

   pnpm

   pnpm add @tauri-apps/plugin-autostart

   deno

   deno add npm:@tauri-apps/plugin-autostart

   bun

   bun add @tauri-apps/plugin-autostart

Utilisation

Le plugin autostart est disponible en JavaScript et en Rust.

JavaScript

import { enable, isEnabled, disable } from '@tauri-apps/plugin-autostart';
// lors de l'utilisation de `"withGlobalTauri": true`, vous pouvez utiliser
// const { enable, isEnabled, disable } = window.__TAURI__.autostart;

// Activer le démarrage automatique
await enable();
// Vérifier l'état d'activation
console.log(`registered for autostart? ${await isEnabled()}`);
// Désactiver le démarrage automatique
disable();

Rust

#[cfg_attr(mobile, tauri::mobile_entry_point)]
pub fn run() {
    tauri::Builder::default()
        .setup(|app| {
            #[cfg(desktop)]
            {
                use tauri_plugin_autostart::MacosLauncher;
                use tauri_plugin_autostart::ManagerExt;

                app.handle().plugin(tauri_plugin_autostart::init(
                    MacosLauncher::LaunchAgent,
                    Some(vec!["--flag1", "--flag2"]),
                ));

                // Obtenir le gestionnaire de démarrage automatique
                let autostart_manager = app.autolaunch();
                // Activer le démarrage automatique
                let _ = autostart_manager.enable();
                // Vérifier l'état d'activation
                println!("registered for autostart? {}", autostart_manager.is_enabled().unwrap());
                // Désactiver le démarrage automatique
                let _ = autostart_manager.disable();
            }
            Ok(())
        })
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

Permissions

Par défaut, toutes les commandes et portées de plugin potentiellement dangereuses sont bloquées et inaccessibles. Vous devez modifier les permissions dans votre configuration capabilities pour les activer.

Consultez la Vue d’ensemble des capacités pour plus d’informations et le guide étape par étape pour utiliser les permissions de plugin.

src-tauri/capabilities/default.json

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

Default Permission

This permission set configures if your application can enable or disable auto starting the application on boot.

Granted Permissions

It allows all to check, enable and disable the automatic start on boot.

This default permission set includes the following:

• allow-enable
• allow-disable
• allow-is-enabled

Permission Table

Identifier	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.