AutoLaunch 1.0.0

AutoLaunch

<img alt="AutoLaunch" src="https://raw.githubusercontent.com/Linlccc/AutoLaunch/master/docs/icon/icon.png" width="128">

English | 简体中文

AutoLaunch is a cross-platform .NET library that provides a unified API for enabling auto-start for applications and executables on Windows, Linux, and macOS systems.

✨ Features

• 🌍 Cross-Platform Support: Windows, Linux, macOS
• 🔧 Multiple Engines: Various implementations for each platform
• 🎯 Ease of Use: Unified API across all platforms
• 🛠 AOT Support: Fully supports AOT and trimming
• 📦 Zero Dependency: No third-party library required

🚚 Supported Engines

Windows

Linux

macOS

📦 Installation

dotnet CLI:

dotnet add package AutoLaunch

Package Manager Console:

Install-Package AutoLaunch

🚀 Quick Start

Unified configuration API for all platforms

Basic Usage

using AutoLaunch;

// Automatically configure for current program
var autoLauncher = new AutoLaunchBuilder().Automatic().Build();

// Enable auto-launch synchronously
autoLauncher.Enable();
// Disable auto-launch synchronously
autoLauncher.Disable();
// Check if enabled synchronously
bool isEnabled = autoLauncher.IsEnabled();

// Enable auto-launch asynchronously
await autoLauncher.EnableAsync();
// Disable auto-launch asynchronously
await autoLauncher.DisableAsync();
// Check if enabled asynchronously
bool isEnabledAsync = await autoLauncher.IsEnabledAsync();

Custom Configuration

var autoLauncher = new AutoLaunchBuilder()
    .SetAppName("MyApp")
    .SetAppPath("/path/to/myapp")
    .SetArgs("arg1", "arg2")
    .AddArgs("arg3")
    .SetWorkScope(WorkScope.CurrentUser) // Set work scope for auto-launch
    .SetWindowsEngine(WindowsEngine.Registry) // Use Registry engine on Windows, ignored on other platforms
    .SetLinuxEngine(LinuxEngine.Freedesktop) // Use Freedesktop engine on Linux, ignored on other platforms
    .SetMacOSEngine(MacOSEngine.LaunchAgent) // Use LaunchAgent engine on macOS, ignored on other platforms
    .SetIdentifiers("com.example.myapp") // Add Bundle Identifier for macOS
    .SetExtraConfigIf(OperatingSystem.IsLinux(), "X-GNOME-Autostart-enabled=true") // Add extra config for Linux, must conform to Freedesktop standard
    .SetExtraConfigIf(OperatingSystem.IsMacOS(), "<key>KeepAlive</key><true/>") // Add extra config for macOS, must conform to LaunchAgent standard
    .Build();

autoLauncher.Enable();

Safe Mode

No exceptions will be thrown in safe mode

// Build an instance in safe mode
var autoLauncher = new AutoLaunchBuilder().Automatic().BuildSafe();

// Try to enable, returns true/false for success/failure
bool success = autoLauncher.TryEnable();

if(!success)
{
   // Get the last exception
    Exception? lastException = autoLauncher.TakeLastException();
    if (lastException is PermissionDeniedException) Console.WriteLine("Permission denied.");
    else Console.WriteLine($"Failed to enable auto-launch: {lastException?.Message}");
}

API Documentation

AutoLaunchBuilder

AutoLauncher Interface

SafeAutoLauncher Extra Methods

⚠️ Exception Types

📜 License

Licensed under the terms of the MIT License.