Enum AgentSubcommand 

pub enum AgentSubcommand {
    Start {
        socket: Option<PathBuf>,
        foreground: bool,
        timeout: String,
    },
    Stop,
    Status,
    Env {
        shell: ShellFormat,
    },
    Lock,
    Unlock {
        key: String,
    },
    InstallService {
        dry_run: bool,
        force: bool,
        manager: Option<ServiceManager>,
    },
    UninstallService,
}

Variants

Start

Start the SSH agent daemon

Fields

socket: Option<PathBuf>

Custom socket path (default: ~/.auths/agent.sock)

foreground: bool

Run in foreground (don’t daemonize)

timeout: String

Idle timeout (e.g., “30m”, “1h”, “0” for never)

Stop

Stop the SSH agent daemon

Status

Show agent status

Env

Output shell environment for SSH_AUTH_SOCK (use with eval)

Fields

shell: ShellFormat

Shell format for output

Lock

Lock the agent (clear keys from memory)

Unlock

Unlock the agent (re-load keys)

Fields

key: String

Key alias to unlock

InstallService

Install as a system service (launchd on macOS, systemd on Linux)

Fields

dry_run: bool

Don’t install, just print the service file

force: bool

Force overwrite if service already exists

manager: Option<ServiceManager>

Service manager to use (auto-detect if not specified)

UninstallService

Uninstall the system service

Trait Implementations

impl Clone for AgentSubcommand

fn clone(&self) -> AgentSubcommand

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AgentSubcommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for AgentSubcommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for AgentSubcommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand