elevated-command

Crates.ioelevated-command
lib.rselevated-command
version1.1.2
sourcesrc
created_at2024-01-02 08:57:19.609781
updated_at2024-01-04 14:35:25.819094
descriptionRun a command using sudo, prompting the user with an OS dialog if necessary
homepagehttps://github.com/vangork/elevated-command
repositoryhttps://github.com/vangork/elevated-command
max_upload_size
id1086044
size35,484
Luis Liu (vangork)

documentation

https://docs.rs/elevated-command

README

elevated-command

crates.io docs.rs

Run command using sudo, prompting the user with a graphical OS dialog if necessary. Useful for background rust applications or native Tauri apps that need sudo.

Cross-Platform

elevated-command provides a native OS dialog prompt on Windows, Linux and MacOS.

Windows

Linux

macOS

Example

Add the following to your Cargo.toml:

[dependencies]
elevated-command = "1.1"

In your main.rs:

use elevated_command::Command;
use std::process::Command as StdCommand;

fn main() {
    let is_elevated = Command::is_elevated();

    let mut cmd = StdCommand::new("path to the application");
    cmd.arg("some arg");

    let output = if is_elevated {
        cmd.output().unwrap()
    } else {
        let elevated_cmd = Command::new(cmd);
        elevated_cmd.output().unwrap()
    };
}

Note: The application should not be sudo.

To get started using elevated-command, please see the API reference (docs.rs).

Behavior

On Windows, elevated-command will elevate your command using User Account Control (UAC).

On Linux, elevated-command will use pkexec to show the password prompt and run your command.

On MacOS, elevated-command should behave just like the sudo command in the shell.

Reference

  1. jorangreef/sudo-prompt

  2. https://stackoverflow.com/questions/8046097/how-to-check-if-a-process-has-the-administrative-rights/8196291#8196291

  3. https://fix.moe/post/macos-app-authorization

License

Licensed under the MIT license.

Commit count: 0

cargo fmt