Struct CliArgs 

pub struct CliArgs {
    pub lang: Option<String>,
    pub verbose: bool,
    pub quiet: bool,
    pub config_dir: Option<PathBuf>,
    pub no_color: bool,
    pub output_format: Option<OutputFormat>,
    pub disable_sudo: bool,
    pub replace_host_key: bool,
    pub allow_plaintext_secrets: bool,
    pub secrets_key_file: Option<PathBuf>,
    pub use_keyring: bool,
    pub command: Command,
}

Global ssh-cli arguments.

Fields

lang: Option<String>

Forces the CLI language (e.g. pt-BR, en-US).

verbose: bool

Increases log verbosity on stderr.

quiet: bool

Suppresses non-JSON output (quiet mode).

config_dir: Option<PathBuf>

Configuration directory override (useful for tests).

no_color: bool

Disables colored output.

output_format: Option<OutputFormat>

Global output format (text, json). If omitted: JSON when stdout is not a TTY.

disable_sudo: bool

Disables sudo-exec/su-exec for this invocation (alias –disableSudo).

replace_host_key: bool

Replaces a diverging host key in TOFU known_hosts.

allow_plaintext_secrets: bool

Allow plaintext secrets at rest (no auto secrets.key). Prefer for tests only.

secrets_key_file: Option<PathBuf>

Path to a 64-hex primary-key file (overrides env / XDG secrets.key for this one-shot).

use_keyring: bool

Prefer OS keyring for the primary key (deprecated env: SSH_CLI_USE_KEYRING).

command: Command

Subcommand to run.

Trait Implementations

impl Args for CliArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

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

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

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

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

impl CommandFactory for CliArgs

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for CliArgs

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

Formats the value using the given formatter.

impl FromArgMatches for CliArgs

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( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for CliArgs

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.