Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

sshpm

TheLastZombie24MIT1.0.0-rc.1

The SSH profile manager.

config, configuration, connection, cyberduck, filezilla, kitty, manager, mremoteng, oclif, openssh, profile, putty, rclone, remmina, ssh, winscp, zoc

readme

sshpm

sshpm allows you to use a single set of SSH connection profiles across multiple SSH-related programs.

Installation

<summary>Using NPM</summary> 
npm i -g sshpm
<summary>Using PNPM</summary> 
pnpm i -g sshpm
<summary>Using Yarn</summary> 
yarn global add sshpm
<summary>Manually</summary>

Download the latest release, extract it and add the bin directory to your PATH.

<summary>From source</summary> 
git clone https://github.com/TheLastZombie/sshpm
cd sshpm
npm i

To run sshpm without compiling, use npm start -- instead of sshpm (i.e. npm start -- help).

To compile sshpm, run the distribution script:

npm run dist

After that, you'll (hopefully) find what you need inside the dist directory.

<summary>Using Scoop</summary>

If you use Scoop but don't want to install Node.js, you can also use my bucket to install sshpm:

scoop bucket add tlz https://github.com/TheLastZombie/scoop-bucket
scoop install sshpm
<summary>With NPX</summary>

If you have NPM installed, you can also prepend all commands with npx (i.e. npx sshpm help).

Keep in mind that this will use a temporary instead of a permanent installation, significantly increasing execution time, since NPX will download sshpm every time a command is run.

Usage

To show general help regarding sshpm, run sshpm or sshpm help.

To show help for a specific command, run sshpm help [COMMAND] or sshpm [COMMAND] --help.

The commands themselves are pretty self-explanatory, and a typical workflow might look like this:

sshpm init
sshpm login "Server 1" -h example.com -o 22 -u username -p password
sshpm login "Server 2" -h example.com -o 22 -u username -k id_rsa
sshpm test "Server 1"
sshpm list
sshpm apply

Programs

The following programs are currently supported:

| | Name | Host | Port | User | Password | Key | | :----------------------------------------------------------: | :--: | :--: | :--: | :--: | :------: | :-: | | Cyberduck | ✕ | ✕ | ✕ | ✕ | | ✕ | | FileZilla | ✕ | ✕ | ✕ | ✕ | ✕ | ✕ | | KiTTY | ✕ | ✕ | ✕ | ✕ | | ✕ | | mRemoteNG | ✕ | ✕ | ✕ | ✕ | | | | OpenSSH | ✕ | ✕ | ✕ | ✕ | | ✕ | | PuTTY | ✕ | ✕ | ✕ | ✕ | | ✕ | | rclone | ✕ | ✕ | ✕ | ✕ | ✕ | ✕ | | Remmina | ✕ | ✕ | ✕ | ✕ | | ✕ | | WinSCP | ✕ | ✕ | ✕ | ✕ | ✕ | ✕ | | WinSCP Portable | ✕ | ✕ | ✕ | ✕ | ✕ | ✕ | | ZOC Terminal | ✕ | ✕ | ✕ | ✕ | | ✕ |