Struct Args 

pub struct Args {

    pub host: String,
    pub port: u16,
    pub user: String,
    pub password: Option<String>,
    pub key: Option<PathBuf>,
    pub spool_dir: Option<PathBuf>,
    pub su_password: Option<String>,
    pub sudo_password: Option<String>,
    pub timeout: u64,
    pub max_chars: Option<String>,
    pub disable_sudo: bool,
    pub max_output_tokens: Option<String>,
    pub log_level: String,
    pub log_file: Option<PathBuf>,
    pub log_format: String,
    pub log_rotation: String,
    pub keepalive_interval: u64,
    pub keepalive_max: u64,
    pub reconnect_retries: u64,
    pub reconnect_backoff_ms: u64,
    pub health_probe_timeout_ms: u64,
    pub strict_host_key_checking: HostKeyCheckMode,
    pub known_hosts: Option<PathBuf>,
}

SeSSHion CLI arguments

Fields

host: String

SSH host to connect to

port: u16

SSH port

user: String

SSH username

password: Option<String>

SSH password (alternative to key)

key: Option<PathBuf>

Path to SSH private key file (alternative to password)

spool_dir: Option<PathBuf>

Absolute local directory for background job logs and state

su_password: Option<String>

Password for su elevation

sudo_password: Option<String>

Password for sudo commands (if different from su_password)

timeout: u64

Command execution timeout in milliseconds

max_chars: Option<String>

Maximum characters for command length. Use “none”, “0”, or negative value to disable limit. Default: 64000

disable_sudo: bool

Disable the sudo_shell and sudo_apply_patch tools

max_output_tokens: Option<String>

Maximum output tokens for command execution. Use “none” or “0” to disable limit. Supports “k” suffix (e.g., “16k” for 16000). Default: 16000 (approximately 64KB)

log_level: String

Logging level: trace, debug, info, warn, error

log_file: Option<PathBuf>

Log file path (default: stdout only)

log_format: String

Log format: text or json

log_rotation: String

Log rotation strategy: daily, hourly, never

keepalive_interval: u64

Keepalive interval in seconds (default: 30) Sends keepalive packets to maintain connection like a human user

keepalive_max: u64

Maximum keepalive failures before disconnecting (default: 3) Total idle timeout = keepalive_interval * keepalive_max

reconnect_retries: u64

Number of reconnect retries after the initial attempt (default: 3)

reconnect_backoff_ms: u64

Base reconnect backoff in milliseconds (default: 250)

health_probe_timeout_ms: u64

Health probe timeout in milliseconds for active session checks (default: 1500)

strict_host_key_checking: HostKeyCheckMode

SSH host key checking mode: yes, accept-new, or no

known_hosts: Option<PathBuf>

Path to known_hosts file (default: OpenSSH user known_hosts)

Trait Implementations

impl Args for Args

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 Clone for Args

fn clone(&self) -> Args

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Args

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 Args

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

Formats the value using the given formatter.

impl FromArgMatches for Args

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 Args

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.