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 json: bool,
    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 timeout: Option<u64>,
    pub max_concurrency: Option<u16>,
    pub fail_fast: bool,
    pub scp_file_concurrency: Option<u16>,
    pub command: Command,
}

Global ssh-cli arguments.

Fields

lang: Option<String>

Forces the CLI language (BCP47; must negotiate to en or pt-BR).

Examples: en, en-US, pt-BR, pt. Invalid tags fail clap validation.

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.

json: bool

Force JSON on stdout (agent; alias of --output-format json; G-AUD-01).

Global — appears before or after subcommands. Subcommand fields use from_global so there is a single --json long name (clap uniqueness).

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 XDG secrets.key for this one-shot).

use_keyring: bool

Prefer OS keyring for the primary key (CLI flag only; no product env store).

timeout: Option<u64>

Global default timeout in milliseconds for SSH ops (exec/scp/health-check). Local --timeout on a subcommand wins. Tunnel still requires --timeout-ms.

max_concurrency: Option<u16>

Cap concurrent multi-host SSH sessions / tunnel forwards (1..=MAX_CONCURRENCY).

Default: auto from CPUs × I/O oversubscribe vs free RAM (see concurrency). Applies to --all fan-out and tunnel accepts (no env store; G-UNSAFE-14).

fail_fast: bool

Stop admitting new multi-host units after the first failure (G-O1).

Default: continue all hosts (agent-friendly partial success). In-flight units still finish; never-started hosts are omitted from batch results unless callers pad skipped rows.

scp_file_concurrency: Option<u16>

Max concurrent SCP file transfers on one SSH session (G-O4).

Default: 1 (serial multi-file, session reuse). Values >1 open parallel SCP channels on the same session (bounded). Env: not used; CLI only.

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.