# ssh-server Latest version **1.2.0** (published 2021-01-12) · MIT license · 0 weekly downloads ## Install ```sh npm install ssh-server pnpm add ssh-server yarn add ssh-server bun add ssh-server ``` Provides the commands `0`, `1`, `2`, `3`, `4`, `5`, `6`. ## Health **Score 20/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities. Warnings: low downloads; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.2.0 | | Published | 2021-01-12 | | First published | 2021-01-10 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=8.0.0 | | Dependencies | 15 | | Unpacked size | 58.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Aaron @Troublor | | Maintainers | troublor | | Keywords | oclif | ## Links - npm: https://www.npmjs.com/package/ssh-server - Repository: Troublor/ssh-server - Homepage: https://github.com/Troublor/ssh-server - Issues: https://github.com/Troublor/ssh-server/issues - npm.io page: https://npm.io/package/ssh-server ## Dependencies (15) - [tslib](https://npm.io/package/tslib.md) ^1 - [js-yaml](https://npm.io/package/js-yaml.md) ^4.0.0 - [@oclif/config](https://npm.io/package/@oclif/config.md) ^1 - [@oclif/errors](https://npm.io/package/@oclif/errors.md) ^1.3.4 - [@oclif/parser](https://npm.io/package/@oclif/parser.md) ^3.8.5 - [@troubkit/cmd](https://npm.io/package/@troubkit/cmd.md) ^0.1.5-alpha.0 - [@troubkit/log](https://npm.io/package/@troubkit/log.md) ^0.1.5-alpha.0 - [@oclif/command](https://npm.io/package/@oclif/command.md) ^1 - [@oclif/dev-cli](https://npm.io/package/@oclif/dev-cli.md) ^1 - [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^3 - [@oclif/plugin-update](https://npm.io/package/@oclif/plugin-update.md) ^1.3.10 - [@oclif/plugin-commands](https://npm.io/package/@oclif/plugin-commands.md) ^1.3.0 - [@oclif/plugin-not-found](https://npm.io/package/@oclif/plugin-not-found.md) ^1.2.4 - [@oclif/plugin-autocomplete](https://npm.io/package/@oclif/plugin-autocomplete.md) ^0.3.0 - [@oclif/plugin-warn-if-update-available](https://npm.io/package/@oclif/plugin-warn-if-update-available.md) ^1.7.0 ## Alternatives - [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads - [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads - [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads - [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads - [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads ## Recent versions - 1.2.0 (latest) — 2021-01-12 - 1.1.3 — 2021-01-10 - 1.1.2 — 2021-01-10 - 1.1.1 — 2021-01-10 - 1.1.0 — 2021-01-10 - 1.0.0 — 2021-01-10 ## README ssh-server ========== [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) [![Version](https://img.shields.io/npm/v/ssh-server.svg)](https://npmjs.org/package/ssh-server) [![Downloads/week](https://img.shields.io/npm/dw/ssh-server.svg)](https://npmjs.org/package/ssh-server) [![License](https://img.shields.io/npm/l/ssh-server.svg)](https://github.com/Troublor/ssh-server/blob/master/package.json) * [Usage](#usage) * [Commands](#commands) # Usage ```sh-session $ npm install -g ssh-server $ ssh-server COMMAND running command... $ ssh-server (-v|--version|version) ssh-server/1.2.0 darwin-x64 node-v14.15.3 $ ssh-server --help [COMMAND] USAGE $ ssh-server COMMAND ... ``` # Commands * [`ssh-server autocomplete [SHELL]`](#ssh-server-autocomplete-shell) * [`ssh-server commands`](#ssh-server-commands) * [`ssh-server copy [SOURCE] [...] [TARGET]`](#ssh-server-copy-source--target) * [`ssh-server help [COMMAND]`](#ssh-server-help-command) * [`ssh-server port:close SERVER REMOTEPORT:LOCALPORT`](#ssh-server-portclose-server-remoteportlocalport) * [`ssh-server port:open SERVER REMOTEPORT:LOCALPORT`](#ssh-server-portopen-server-remoteportlocalport) * [`ssh-server shell [SERVER]`](#ssh-server-shell-server) * [`ssh-server update [CHANNEL]`](#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](https://github.com/oclif/plugin-autocomplete/blob/v0.3.0/src/commands/autocomplete/index.ts)_ ## `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](https://github.com/oclif/plugin-commands/blob/v1.3.0/src/commands/commands.ts)_ ## `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 -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](https://github.com/Troublor/ssh-server/blob/v1.2.0/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](https://github.com/oclif/plugin-help/blob/v3.2.1/src/commands/help.ts)_ ## `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 -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](https://github.com/Troublor/ssh-server/blob/v1.2.0/src/commands/port/close.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 -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](https://github.com/Troublor/ssh-server/blob/v1.2.0/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 -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](https://github.com/Troublor/ssh-server/blob/v1.2.0/src/commands/shell.ts)_ ## `ssh-server update [CHANNEL]` update the ssh-server CLI ``` USAGE $ ssh-server update [CHANNEL] ``` _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v1.3.10/src/commands/update.ts)_ --- _Source: https://npm.io/package/ssh-server · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._