• Public
  • Public/Protected
  • All



setups SSH quickly and in a painless manner

Status for master

build status coverage report npm downloads per month Known Vulnerabilities TypeScript node JavaScript Style Guide


var smartssh = require('smartssh');
var sshInstance = new smartssh.sshInstance({
  sshDir: '/some/path/.ssh', // the standard ssh directory, optional, defaults to "~./.ssh"
  sshSync: true // sync ssh this instance will represent the status of an ssh dir if set to true;

  new smartssh.sshKey({
    private: 'somestring',
    public: 'somestring', // optional
    host: 'github.com',
    encoding: 'base64' // optional, defaults to "utf8", can be "utf8" or "base64", useful for reading ssh keys from environment variables

sshInstance.removeKey(sshInstance.getKey('github.com')); // removes key for host "github.com" is present

  host: 'gitlab.com' // returns new key in the form sshKey, read more about the sshKey class below

  // returns ssh key in the form sshKey, read more about the sshKey class below
  host: 'github.com'

sshInstance.getKeys(); // returns array of all available getKeys. Each key is in form of class sshKey

For further information read the linked docs at the top of this readme.

MIT licensed | © Lossless GmbH | By using this npm module you agree to our privacy policy


Generated using TypeDoc