Autostart

Autostart

app.Autostart registriert Ihre Anwendung so, dass sie automatisch gestartet wird, wenn sich der Benutzer anmeldet. Dabei wird für jede Plattform der passende native Mechanismus ausgewählt und über symbolische Links referenzierte Installationspfade (Homebrew, Scoop) werden aufgelöst, damit Registrierungen bei einem Upgrade der Binärdatei nicht ungültig werden.

Die Registrierung wird erst bei der nächsten Anmeldung wirksam, nicht sofort.

Schnellstart

import "github.com/wailsapp/wails/v3/pkg/application"

// Register to launch at login
if err := app.Autostart.Enable(); err != nil {
    app.Logger.Error("autostart enable failed", "error", err)
}

// Stop launching at login
if err := app.Autostart.Disable(); err != nil {
    app.Logger.Error("autostart disable failed", "error", err)
}

// Check status
enabled, err := app.Autostart.IsEnabled()

API

Enable

Registriert die Anwendung mit den Standardoptionen für den Start bei der Anmeldung.

func (m *AutostartManager) Enable() error

Enable kann gefahrlos wiederholt aufgerufen werden – die Registrierung wird jedes Mal überschrieben. Daher können Sie die Funktion bei jedem Start aufrufen, wenn Sie die Einstellung des Benutzers dauerhaft gespeichert haben.

EnableWithOptions

Registriert die Anwendung mit benutzerdefinierten Optionen.

func (m *AutostartManager) EnableWithOptions(opts AutostartOptions) error

AutostartOptions:

Disable

Entfernt die Autostart-Registrierung. Gibt nil zurück, wenn die Anwendung nicht registriert war – das Deaktivieren ist idempotent.

func (m *AutostartManager) Disable() error

IsEnabled

Gibt an, ob eine Registrierung vorhanden ist. Schnell – der registrierte Pfad wird nicht validiert.

func (m *AutostartManager) IsEnabled() (bool, error)

Status

Gibt den vollständigen Registrierungsstatus zurück.

func (m *AutostartManager) Status() (AutostartStatus, error)

AutostartStatus:

Plattformverhalten

Type=Application
Hidden=false
X-GNOME-Autostart-enabled=true
Exec=<executable> <arguments>

if err := app.Autostart.Enable(); err != nil {
    if errors.Is(err, application.ErrAutostartNotSupported) {
        // hide the toggle in the UI
        return
    }
    // real failure — surface it
}

Bezeichner

Wenn Options.Identifier leer ist, wird aus dem Namen Ihrer Anwendung ein Standardwert abgeleitet:

Bezeichner müssen ^[A-Za-z0-9._-]+$ entsprechen und dürfen höchstens 200 Zeichen lang sein. Für macOS wird die umgekehrte DNS-Notation empfohlen, da sie der üblichen Schreibweise von launchd-Labels entspricht.

Wenn AutostartOptions.Identifier überschrieben wird, wird derselbe Bezeichner unter Windows als Name des Registrierungswerts und unter Linux als Dateiname für .desktop wiederverwendet, sodass eine einzige Zeichenfolge die Registrierung plattformübergreifend identifiziert.

Erkennung veralteter Registrierungen

Disable() und Status() finden die Registrierung, indem sie den Pfad der registrierten ausführbaren Datei mit os.Executable() (nach Auflösung aller symbolischen Links) abgleichen, nicht durch Nachschlagen des Bezeichners. Das bedeutet:

• Der Bezeichner kann zwischen Releases gefahrlos geändert werden. Die alte Registrierung kann weiterhin von Status() gefunden und von Disable() bereinigt werden – solange der Pfad der ausführbaren Datei unverändert ist.
• Eine zweite Kopie der App unter einem anderen Pfad überschreibt die Registrierung der ersten nicht. Jeder Speicherort der Binärdatei wird unabhängig verwaltet.
• Über symbolische Links installierte Apps (Homebrew, Scoop) bleiben stabil. filepath.EvalSymlinks wird vor dem Abgleich auf os.Executable() angewendet. Daher hinterlässt ein Homebrew-Upgrade, das das Ziel austauscht, keinen verwaisten Eintrag.

Was dadurch nicht abgedeckt ist: Wenn der Benutzer die Binärdatei an einen nicht verwandten Pfad verschiebt oder sie umbenennt, wird die alte Registrierung verwaist (sie verweist auf die nun fehlende Datei). Apps, die von einem stabilen Installationspfad aus bereitgestellt werden, müssen dies nicht berücksichtigen. Apps, die als portable Einzeldatei-Binärdateien bereitgestellt werden, sollten vor dem Verschieben ihrer eigenen Binärdatei Disable() aufrufen oder immer über einen stabilen symbolischen Link gestartet werden.

Beispiel

package main

import (
    "errors"

    "github.com/wailsapp/wails/v3/pkg/application"
)

func main() {
    app := application.New(application.Options{
        Name: "My App",
    })

    // Restore the user's preference on startup
    if userPrefersAutostart() {
        if err := app.Autostart.Enable(); err != nil {
            if !errors.Is(err, application.ErrAutostartNotSupported) {
                app.Logger.Error("autostart", "error", err)
            }
        }
    }

    app.Run()
}

Ein vollständiges ausführbares Beispiel mit Schaltflächen für Status, Aktivieren und Deaktivieren befindet sich in examples/autostart/.