ssh-cli 0.5.5

Native Rust CLI that gives LLMs (Claude Code, Cursor, Windsurf) the ability to operate remote servers via SSH over stdin/stdout
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

// SPDX-License-Identifier: MIT OR Apache-2.0
// G-SFTP-R12: SCP clap surface extracted from cli/mod (SRP; parity with sftp_args).
#![forbid(unsafe_code)]
//! Clap types for `ssh-cli scp …` (regular files only).

use super::SshAuthArgs;
use clap::{ArgAction, Subcommand};

/// Actions of the `scp` subcommand (regular files only; no `-r`).
///
/// Directory trees use [`super::SftpAction`] (`ssh-cli sftp … --recursive`).
#[derive(Debug, Subcommand)]
pub enum ScpAction {
    /// Uploads a local file to the remote host (regular files only).
    Upload {
        /// Upload to every registered host (bounded concurrency).
        #[arg(long, action = ArgAction::SetTrue, conflicts_with = "hosts")]
        all: bool,
        /// Comma-separated host subset (bounded fan-out).
        #[arg(long, value_name = "LIST", conflicts_with = "all")]
        hosts: Option<String>,
        /// Named source slot (repeatable). Pairs with `--dest`; never remaps a positional.
        #[arg(long = "src", value_name = "PATH", action = ArgAction::Append)]
        src: Vec<String>,
        /// Named destination slot. Always a directory, whatever the source count.
        #[arg(long = "dest", value_name = "DIR")]
        dest: Option<String>,
        /// Paths: `VPS LOCAL REMOTE`, or `VPS LOCAL... REMOTE_DIR` (multi-file, one session),
        /// or with `--all`/`--hosts`: `LOCAL REMOTE` (one file only — more sources need `--src`/`--dest`).
        #[arg(num_args = 0.., value_names = ["VPS", "LOCAL", "REMOTE"])]
        target: Vec<String>,
        /// SSH authentication overrides (password/key/passphrase).
        #[command(flatten)]
        auth: SshAuthArgs,
        /// SSH timeout override in milliseconds (covers connect+transfer).
        #[arg(long, value_name = "MS")]
        timeout: Option<u64>,
        /// JSON output (from global `--json`).
        #[arg(from_global)]
        json: bool,
    },

    /// Downloads a remote file to the local host (regular files only).
    Download {
        /// Download from every registered host (bounded concurrency).
        #[arg(long, action = ArgAction::SetTrue, conflicts_with = "hosts")]
        all: bool,
        /// Comma-separated host subset (bounded fan-out).
        #[arg(long, value_name = "LIST", conflicts_with = "all")]
        hosts: Option<String>,
        /// Named source slot (repeatable). Pairs with `--dest`; never remaps a positional.
        #[arg(long = "src", value_name = "PATH", action = ArgAction::Append)]
        src: Vec<String>,
        /// Named destination slot. Always a directory, whatever the source count.
        #[arg(long = "dest", value_name = "DIR")]
        dest: Option<String>,
        /// Paths: `VPS REMOTE LOCAL`, or `VPS REMOTE... LOCAL_DIR` (multi-file, one session),
        /// or with `--all`/`--hosts`: `REMOTE LOCAL` (one file only — more sources need `--src`/`--dest`).
        #[arg(num_args = 0.., value_names = ["VPS", "REMOTE", "LOCAL"])]
        target: Vec<String>,
        /// SSH authentication overrides (password/key/passphrase).
        #[command(flatten)]
        auth: SshAuthArgs,
        /// SSH timeout override in milliseconds (covers connect+transfer).
        #[arg(long, value_name = "MS")]
        timeout: Option<u64>,
        /// JSON output (from global `--json`).
        #[arg(from_global)]
        json: bool,
    },
}