@troubkit/ssh-server v1.3.3

ssh-server

• Usage
• Commands

Usage

$ npm install -g @troubkit/ssh-server
$ ssh-server COMMAND
running command...
$ ssh-server (-v|--version|version)
@troubkit/ssh-server/1.3.0 darwin-x64 node-v14.15.3
$ ssh-server --help [COMMAND]
USAGE
  $ ssh-server COMMAND
...

Commands

• ssh-server autocomplete [SHELL]
• ssh-server commands
• ssh-server copy [SOURCE] [...] [TARGET]
• ssh-server help [COMMAND]
• ssh-server port:close SERVER REMOTEPORT:LOCALPORT
• ssh-server port:list SERVER REMOTEPORT:LOCALPORT
• ssh-server port:open SERVER REMOTEPORT:LOCALPORT
• ssh-server shell [SERVER]
• ssh-server update [CHANNEL]

ssh-server autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ ssh-server autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ ssh-server autocomplete
  $ ssh-server autocomplete bash
  $ ssh-server autocomplete zsh
  $ ssh-server autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

ssh-server commands

list all the commands

USAGE
  $ ssh-server commands

OPTIONS
  -h, --help              show CLI help
  -j, --json              display unfiltered api data in json format
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --hidden                show hidden commands
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

See code: @oclif/plugin-commands

ssh-server copy [SOURCE] [...] [TARGET]

open server shell

USAGE
  $ ssh-server copy [SOURCE] [...] [TARGET]

OPTIONS
  -H, --host=host                  host of the server
  -P, --port=port                  port of the ssh server
  -h, --help                       show CLI help
  -i, --identityFile=identityFile  path to ssh identity file to logon server
  -p, --password=password          password to logon server
  -q, --quiet
  -r, --recursive                  recursive copy
  -u, --username=username          username used to logon server
  --home=home                      home path on the server

ALIASES
  $ ssh-server cp

EXAMPLE
  $ ssh-server copy -r server:~/workspace ~/

See code: src/commands/copy.ts

ssh-server help [COMMAND]

display help for ssh-server

USAGE
  $ ssh-server help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

ssh-server port:close SERVER REMOTEPORT:LOCALPORT

close ssh local port forwarding

USAGE
  $ ssh-server port:close SERVER REMOTEPORT:LOCALPORT

ARGUMENTS
  SERVER                name of server predefined in config file
  REMOTEPORT:LOCALPORT  port forward pattern

OPTIONS
  -H, --host=host                  host of the server
  -P, --port=port                  port of the ssh server
  -h, --help                       show CLI help
  -i, --identityFile=identityFile  path to ssh identity file to logon server
  -p, --password=password          password to logon server
  -q, --quiet
  -r, --recursive                  recursive copy
  -u, --username=username          username used to logon server
  --home=home                      home path on the server

EXAMPLE
  $ ssh-server port:close remotePort:localPort ...

See code: src/commands/port/close.ts

ssh-server port:list SERVER REMOTEPORT:LOCALPORT

close ssh local port forwarding

USAGE
  $ ssh-server port:list SERVER REMOTEPORT:LOCALPORT

ARGUMENTS
  SERVER                name of server predefined in config file
  REMOTEPORT:LOCALPORT  port forward pattern

OPTIONS
  -H, --host=host                  host of the server
  -P, --port=port                  port of the ssh server
  -h, --help                       show CLI help
  -i, --identityFile=identityFile  path to ssh identity file to logon server
  -p, --password=password          password to logon server
  -q, --quiet
  -r, --recursive                  recursive copy
  -u, --username=username          username used to logon server
  --home=home                      home path on the server

EXAMPLE
  $ ssh-server port:close remotePort:localPort ...

See code: src/commands/port/list.ts

ssh-server port:open SERVER REMOTEPORT:LOCALPORT

open ssh local port forwarding

USAGE
  $ ssh-server port:open SERVER REMOTEPORT:LOCALPORT

ARGUMENTS
  SERVER                name of server predefined in config file
  REMOTEPORT:LOCALPORT  port forward pattern

OPTIONS
  -H, --host=host                  host of the server
  -P, --port=port                  port of the ssh server
  -h, --help                       show CLI help
  -i, --identityFile=identityFile  path to ssh identity file to logon server
  -p, --password=password          password to logon server
  -q, --quiet
  -r, --recursive                  recursive copy
  -u, --username=username          username used to logon server
  --home=home                      home path on the server

EXAMPLE
  $ ssh-server port:open localPort:remotePort ...

See code: src/commands/port/open.ts

ssh-server shell [SERVER]

open server shell

USAGE
  $ ssh-server shell [SERVER]

ARGUMENTS
  SERVER  name of server predefined in config file

OPTIONS
  -H, --host=host                  host of the server
  -P, --port=port                  port of the ssh server
  -h, --help                       show CLI help
  -i, --identityFile=identityFile  path to ssh identity file to logon server
  -p, --password=password          password to logon server
  -q, --quiet
  -r, --recursive                  recursive copy
  -u, --username=username          username used to logon server
  --home=home                      home path on the server

ALIASES
  $ ssh-server sh

EXAMPLE
  $ ssh-server shell [serverName]

See code: src/commands/shell.ts

ssh-server update [CHANNEL]

update the ssh-server CLI

USAGE
  $ ssh-server update [CHANNEL]

See code: @oclif/plugin-update