sftp.ts

import { knownHosts, configHosts } from "./ssh";

const completionSpec: Fig.Spec = {
  name: "sftp",
  description: "OpenSSH secure file transfer",
  args: [
    {
      name: "sources",
      description: "File or directory, local or remote ([user@]host:[path])",
      isVariadic: true,
      generators: [
        knownHosts,
        configHosts,
        { template: ["history", "filepaths", "folders"] },
      ],
    },
    {
      name: "target",
      description: "File or directory, local or remote ([user@]host:[path])",
      generators: [
        knownHosts,
        configHosts,
        { template: ["history", "filepaths", "folders"] },
      ],
    },
  ],
  options: [
    {
      name: ["--help", "-h"],
      description: "Show help for sftp",
    },
    {
      name: "-4",
      description: "Forces scp to use IPv4 addresses only",
    },
    {
      name: "-6",
      description: "Forces scp to use IPv6 addresses only",
    },
    {
      name: "-A",
      description:
        "Allows forwarding of ssh-agent(1) to the remote system. The default is not to forward an authentication agent",
    },
    {
      name: "-a",
      description: `Attempt to continue interrupted transfers rather than overwriting
existing partial or complete copies of files.  If the partial
contents differ from those being transferred, then the resultant
file is likely to be corrupt`,
    },
    {
      name: "-B",
      description: `Specify the size of the buffer that sftp uses when transferring
files.  Larger buffers require fewer round trips at the cost of
higher memory consumption.  The default is 32768 bytes`,
      args: {
        name: "buffer_size",
        description: "The buffer size",
        suggestions: ["32768"],
        default: "32768",
      },
    },
    {
      name: "-b",
      description: `Batch mode reads a series of commands from an input batchfile
instead of stdin.  Since it lacks user interaction it should be
used in conjunction with non-interactive authentication to obviate
the need to enter a password at connection time (see sshd(8) and
ssh-keygen(1) for details)`,
      args: {
        name: "batchfile",
        description: "The batch file",
        template: "filepaths",
      },
    },
    {
      name: "-C",
      description:
        "Compression enable. Passes the -C flag to ssh(1) to enable compression",
    },
    {
      name: "-c",
      description:
        "Selects the cipher to use for encrypting the data transfer. This option is directly passed to ssh(1)",
      args: {
        name: "cipher",
        description: "The selected cipher specification",
      },
    },
    {
      name: "-D",
      description: `Connect directly to a local sftp server (rather than via ssh(1)).
This option may be useful in debugging the client and server`,
      args: {
        name: "sftp_server_path",
        description: "Path to the SFTP server",
      },
    },
    {
      name: "-F",
      description:
        "Specifies an alternative per-user configuration file for ssh. This option is directly passed to ssh(1)",
      args: {
        name: "ssh_config",
        description: "The selected ssh config",
      },
    },
    {
      name: "-f",
      description:
        "Requests that files be flushed to disk immediately after transfer",
    },
    {
      name: "-i",
      description:
        "Selects the file from which the identity (private key) for public key authentication is read. This option is directly passed to ssh(1)",
      args: {
        name: "identity_file",
        description: "Specified identity file",
      },
    },
    {
      name: "-J",
      description: `Connect to the target host by first making an scp connection to the
jump host described by destination and then establishing a TCP
forwarding to the ultimate destination from there.  Multiple jump
hops may be specified separated by comma characters.  This is a
shortcut to specify a ProxyJump configuration directive.  This
option is directly passed to ssh(1)`,
      args: {
        name: "destination",
        description: "Scp destination",
      },
    },
    {
      name: "-l",
      description: "Limits the used bandwidth, specified in Kbit/s",
      args: {
        name: "limit",
        description: "Limit bandwidth in Kbit/s",
      },
    },
    {
      name: "-N",
      description:
        "Disables quiet mode, e.g. to override the implicit quiet mode set by the -b flag",
    },
    {
      name: "-o",
      description: `Can be used to pass options to ssh in the format used in
ssh_config(5).  This is useful for specifying options for which
there is no separate scp command-line flag.  For full details of
the options listed below, and their possible values, see
ssh_config(5)`,
      args: {
        name: "option",
        suggestions: [
          { name: "AddressFamily" },
          { name: "BatchMode" },
          { name: "BindAddress" },
          { name: "ChallengeResponseAuthentication" },
          { name: "CheckHostIP" },
          { name: "Cipher" },
          { name: "Ciphers" },
          { name: "ClearAllForwardings" },
          { name: "Compression" },
          { name: "CompressionLevel" },
          { name: "ConnectionAttempts" },
          { name: "ConnectTimeout" },
          { name: "ControlMaster" },
          { name: "ControlPath" },
          { name: "ControlPersist" },
          { name: "DynamicForward" },
          { name: "EscapeChar" },
          { name: "ExitOnForwardFailure" },
          { name: "ForwardAgent" },
          { name: "ForwardX11" },
          { name: "ForwardX11Timeout" },
          { name: "ForwardX11Trusted" },
          { name: "GatewayPorts" },
          { name: "GlobalKnownHostsFile" },
          { name: "GSSAPIAuthentication" },
          { name: "GSSAPIDelegateCredentials" },
          { name: "HashKnownHosts" },
          { name: "Host" },
          { name: "HostbasedAuthentication" },
          { name: "HostKeyAlgorithms" },
          { name: "HostKeyAlias" },
          { name: "HostName" },
          { name: "IdentityFile" },
          { name: "IdentitiesOnly" },
          { name: "IPQoS" },
          { name: "KbdInteractiveAuthentication" },
          { name: "KbdInteractiveDevices" },
          { name: "KexAlgorithms" },
          { name: "LocalCommand" },
          { name: "LocalForward" },
          { name: "LogLevel" },
          { name: "MACs" },
          { name: "NoHostAuthenticationForLocalhost" },
          { name: "NumberOfPasswordPrompts" },
          { name: "PasswordAuthentication" },
          { name: "PermitLocalCommand" },
          { name: "PKCS11Provider" },
          { name: "Port" },
          { name: "PreferredAuthentications" },
          { name: "Protocol" },
          { name: "ProxyCommand" },
          { name: "PubkeyAuthentication" },
          { name: "RekeyLimit" },
          { name: "RequestTTY" },
          { name: "RhostsRSAAuthentication" },
          { name: "RSAAuthentication" },
          { name: "SendEnv" },
          { name: "ServerAliveInterval" },
          { name: "ServerAliveCountMax" },
          { name: "StrictHostKeyChecking" },
          { name: "TCPKeepAlive" },
          { name: "Tunnel" },
          { name: "TunnelDevice" },
          { name: "UsePrivilegedPort" },
          { name: "User" },
          { name: "UserKnownHostsFile" },
          { name: "VerifyHostKeyDNS" },
          { name: "VisualHostKey" },
          { name: "XAuthLocation" },
        ],
      },
    },
    {
      name: "-P",
      description: `Specifies the port to connect to on the remote host.  Note that
this option is written with a capital ‘P’, because -p is already
reserved for preserving the times and modes of the file`,
      args: {
        name: "port",
      },
    },
    {
      name: "-p",
      description:
        "Preserves modification times, access times, and modes from the original file",
    },
    {
      name: "-q",
      description:
        "Quiet mode: disables the progress meter as well as warning and diagnostic messages from ssh(1)",
    },
    {
      name: "-R",
      description: `Specify how many requests may be outstanding at any one time.
Increasing this may slightly improve file transfer speed but will
increase memory usage.  The default is 64 outstanding requests`,
      args: {
        name: "num_requests",
        description: "The number of requests",
        suggestions: ["64"],
        default: "64",
      },
    },
    {
      name: "-r",
      description:
        "Recursively copy entire directories.  Note that scp follows symbolic links encountered in the tree traversal",
    },
    {
      name: "-S",
      description:
        "Name of program to use for the encrypted connection.  The program must understand ssh(1) options",
      args: {
        name: "program",
      },
    },
    {
      name: "-s",
      description: `Specifies the SSH2 subsystem or the path for an sftp server on the
remote host.  A path is useful when the remote sshd(8) does not
have an sftp subsystem configured`,
      args: {
        name: "subsystem | sftp_server",
        description: "Path to the SFTP server",
      },
    },
    {
      name: "-v",
      description:
        "Verbose mode.  Causes scp and ssh(1) to print debugging messages about their progress. This is helpful in debugging connection, authentication, and configuration problems",
    },
  ],
};

export default completionSpec;