Enum Command

Source

pub enum Command {
Show 16 variants    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: Option<String>,
        remote_port: Option<u16>,
        socks5: bool,
        remote_socket: Option<String>,
        reverse: bool,
        timeout_ms: u64,
        auth: SshAuthArgs,
        json: bool,
        bind: IpAddr,
        i_accept_network_exposure: bool,
    },
    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,
    },
}

Expand description

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 to bind — with --reverse, the local port that receives.

§remote_host: Option<String>

Remote host — with --reverse, the address the server binds.

Optional since 0.5.4: --socks5 chooses a destination per connection and --remote-socket names a Unix socket, so neither has one.

§remote_port: Option<u16>

Remote port — with --reverse, the server port (0 = server allocates).

Reverse accepts 0 because the server then reports the port it bound; a local forward cannot, since there is nothing to connect to.

§socks5: bool

Serve a SOCKS5 proxy locally instead of a fixed forward (G-TUN-R02).

§remote_socket: Option<String>

Forward to a Unix domain socket on the remote host (G-TUN-R03).

§reverse: bool

Ask the server to listen and deliver connections back here (G-TUN-R01).

§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: IpAddr

Local bind address (default loopback for security).

G-TUN-R08: validated by clap as an IP address, so a typo like 127.0.0..1 fails at parse time (exit 2) instead of after resolving the host, opening the SSH session and authenticating — which on a host with MFA or slow auth meant paying a full handshake to learn about a typo.

§i_accept_network_exposure: bool

Acknowledge that a non-loopback bind exposes the forwarded service.

G-TUN-R13: required for any routable bind. Without it, --bind 0.0.0.0 silently published the remote service to the local network. Under --reverse it guards the server’s bind address instead, which is the end that is exposed in that direction.

§