Enum Command 

pub enum Command {
    Vps {
        action: VpsAction,
    },
    Connect {
        name: String,
    },
    Exec {
        all: bool,
        hosts: Option<String>,
        tags: Option<String>,
        target: Vec<String>,
        steps: Vec<String>,
        json: bool,
        auth: SshAuthArgs,
        timeout: Option<u64>,
        description: Option<String>,
    },
    SudoExec {
        all: bool,
        hosts: Option<String>,
        tags: Option<String>,
        target: Vec<String>,
        steps: Vec<String>,
        json: bool,
        auth: SshAuthArgs,
        sudo_password: Option<String>,
        sudo_password_stdin: bool,
        timeout: Option<u64>,
        description: Option<String>,
    },
    SuExec {
        all: bool,
        hosts: Option<String>,
        tags: Option<String>,
        target: Vec<String>,
        steps: Vec<String>,
        json: bool,
        auth: SshAuthArgs,
        su_password: Option<String>,
        su_password_stdin: bool,
        timeout: Option<u64>,
        description: Option<String>,
    },
    Scp {
        action: ScpAction,
    },
    Sftp {
        action: SftpAction,
    },
    Tunnel {
        vps_name: String,
        local_port: u16,
        remote_host: String,
        remote_port: u16,
        timeout_ms: u64,
        auth: SshAuthArgs,
        json: bool,
        bind: String,
    },
    HealthCheck {
        vps_name: Option<String>,
        all: bool,
        hosts: Option<String>,
        json: bool,
        auth: SshAuthArgs,
        timeout: Option<u64>,
    },
    Secrets {
        action: SecretsAction,
    },
    Completions {
        shell: Shell,
    },
    Commands {
        json: bool,
    },
    Schema {
        name: Option<String>,
        json: bool,
    },
    Doctor {
        json: bool,
        probe_ssh: bool,
        hosts: Option<String>,
    },
    Locale {
        json: bool,
        action: Option<LocaleAction>,
    },
    Tls {
        json: bool,
        action: TlsAction,
    },
}

Top-level subcommands.

Variants

Vps

Manages registered VPS hosts.

Fields

action: VpsAction

Specific VPS CRUD action.

Connect

Sets the active VPS (writes sibling active file in the config directory).

Fields

name: String

Name of the VPS previously added via vps add.

Exec

Runs a command on the VPS over SSH (stdout/stderr captured).

Positionals: VPS COMMAND, or with --all/--hosts, only COMMAND (ssh-cli exec --all uptime, ssh-cli exec --hosts a,b uptime). Extra steps on the same SSH session: --step cmd2 --step cmd3 (G-O3).

Fields

all: bool

Run on every registered host (bounded concurrency). When set, pass only the shell command as the single positional.

hosts: Option<String>

Comma-separated host subset (bounded fan-out). Batch JSON even for one name.

tags: Option<String>

Select hosts that have any of these tags (OR). Batch JSON (G-O2).

target: Vec<String>

VPS COMMAND (one host) or COMMAND only when --all / --hosts / --tags.

steps: Vec<String>

Additional commands on the same SSH session after the primary (G-O3).

json: bool

JSON output (from global --json / format; G-AUD-01).

auth: SshAuthArgs

SSH authentication overrides (password/key/passphrase).

timeout: Option<u64>

Timeout override in milliseconds.

description: Option<String>

Shell comment appended for audit trails.

SudoExec

Runs a command with sudo (safe sh -c packing).

Positionals: VPS COMMAND or, with --all/--hosts/--tags, only COMMAND.

Fields

all: bool

Run on every registered host (bounded concurrency).

hosts: Option<String>

Comma-separated host subset (bounded fan-out).

tags: Option<String>

Select hosts by tag (OR). Batch JSON (G-O2).

target: Vec<String>

VPS COMMAND (one host) or COMMAND only when batch selection.

steps: Vec<String>

Extra commands on the same session (G-O3).

json: bool

JSON output (from global --json / format; G-AUD-01).

auth: SshAuthArgs

SSH authentication overrides (password/key/passphrase).

sudo_password: Option<String>

Sudo password override.

sudo_password_stdin: bool

Reads the sudo password from stdin.

timeout: Option<u64>

Timeout override in milliseconds.

description: Option<String>

Shell comment appended for audit.

SuExec

Runs a command with one-shot su - elevation.

Positionals: VPS COMMAND or, with --all/--hosts, only COMMAND.

Fields

all: bool

Run on every registered host (bounded concurrency).

hosts: Option<String>

Comma-separated host subset (bounded fan-out).

tags: Option<String>

Select hosts by tag (OR). Batch JSON (G-O2).

target: Vec<String>

VPS COMMAND (one host) or COMMAND only when batch selection.

steps: Vec<String>

Extra commands on the same session (G-O3).

json: bool

JSON output (from global --json / format; G-AUD-01).

auth: SshAuthArgs

SSH authentication overrides (password/key/passphrase).

su_password: Option<String>

Su password override.

su_password_stdin: bool

Reads the su password from stdin.

timeout: Option<u64>

Timeout override.

description: Option<String>

Shell comment appended for audit.

Scp

SCP file transfer (upload/download).

Fields

action: ScpAction

Specific SCP action.

Sftp

SFTP subsystem transfer and remote filesystem ops (G-SFTP).

Fields

action: SftpAction

Specific SFTP action.

Tunnel

SSH tunnel with mandatory deadline (bounded one-shot).

Contract: one local bind + one SSH session per invocation (G-PAR-30). Multi-host tunnels = N one-shots with distinct --bind/ports. Forward accepts still use JoinSet + Semaphore (--max-concurrency).

Fields

vps_name: String

VPS name (single host only — no --all / --hosts).

local_port: u16

Local port.

remote_host: String

Remote host.

remote_port: u16

Remote port.

timeout_ms: u64

Mandatory tunnel timeout in milliseconds.

auth: SshAuthArgs

SSH authentication overrides (password/key/passphrase).

json: bool

Agent-first JSON output when the local listener is up (GAP-SSH-IO-008).

bind: String

Local bind address (default loopback for security).

HealthCheck

Checks SSH connectivity to a VPS (or multi-host with --all / --hosts).

Fields

vps_name: Option<String>

VPS name (uses active if omitted; ignored with --all / --hosts).

all: bool

Probe every registered host in parallel (bounded concurrency).

hosts: Option<String>

Comma-separated host subset (bounded fan-out). Batch JSON even for one name.

json: bool

JSON output (GAP-SSH-IO-002). Single host: classic object; multi: batch.

auth: SshAuthArgs

SSH authentication overrides (password/key/passphrase).

timeout: Option<u64>

SSH timeout override in milliseconds (GAP-SSH-CLI-004).

Secrets

Manages the primary key and at-rest secret encryption (one-shot).

Fields

action: SecretsAction

Secrets action.

Completions

Generates shell completions.

Fields

shell: Shell

Target shell.

Commands

Emits the full command tree as JSON (agent discovery / rules mycli commands).

Fields

json: bool

JSON output (from global --json).

Schema

Emits embedded JSON Schema catalog or one schema body (G-E2E-02).

Fields

name: Option<String>

Schema name (omit to list catalog). Example: vps-list.

json: bool

JSON catalog envelope when listing (from global --json).

Doctor

Root alias for vps doctor (XDG / schema diagnostics; G-E2E-03).

Fields

json: bool

JSON output (from global --json).

probe_ssh: bool

Also probe SSH health on registered hosts.

hosts: Option<String>

Comma-separated host subset for --probe-ssh.

Locale

Diagnoses and manages UI language (locale resolution / XDG preference).

Fields

json: bool

JSON diagnostics (from global --json / format).

action: Option<LocaleAction>

Optional locale action (default: show status).

Tls

TLS stack: provider status, mTLS identities, ACME certs (XDG; rustls only).

Fields

json: bool

JSON output (from global --json).

action: TlsAction

TLS action.

Trait Implementations

impl Debug for Command

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

Formats the value using the given formatter.

impl FromArgMatches for Command

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 Command

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