2016-04-25 03:06:39 +00:00
|
|
|
# smartssh
|
2018-09-17 20:32:31 +00:00
|
|
|
|
2016-04-25 03:06:39 +00:00
|
|
|
setups SSH quickly and in a painless manner
|
|
|
|
|
|
2017-06-15 15:52:22 +00:00
|
|
|
> Attention: This is still alpha, so some things won't work, not all things are implemented.
|
2016-04-25 03:06:39 +00:00
|
|
|
|
2016-11-23 11:44:31 +00:00
|
|
|
## Availabililty
|
2018-09-17 20:32:31 +00:00
|
|
|
|
2016-11-23 11:44:31 +00:00
|
|
|
[](https://www.npmjs.com/package/smartssh)
|
|
|
|
|
[](https://gitlab.com/pushrocks/smartssh)
|
|
|
|
|
[](https://github.com/pushrocks/smartssh)
|
|
|
|
|
[](https://pushrocks.gitlab.io/smartssh/)
|
|
|
|
|
|
|
|
|
|
## Status for master
|
2018-09-17 20:32:31 +00:00
|
|
|
|
2016-11-23 11:44:31 +00:00
|
|
|
[](https://gitlab.com/pushrocks/smartssh/commits/master)
|
|
|
|
|
[](https://gitlab.com/pushrocks/smartssh/commits/master)
|
|
|
|
|
[](https://www.npmjs.com/package/smartssh)
|
|
|
|
|
[](https://david-dm.org/pushrocks/smartssh)
|
|
|
|
|
[](https://www.bithound.io/github/pushrocks/smartssh/master/dependencies/npm)
|
|
|
|
|
[](https://www.bithound.io/github/pushrocks/smartssh)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
|
|
|
[](http://standardjs.com/)
|
2016-11-23 11:38:38 +00:00
|
|
|
|
2016-04-25 03:06:39 +00:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```javascript
|
2018-09-17 20:32:31 +00:00
|
|
|
var smartssh = require('smartssh');
|
2016-04-25 03:24:10 +00:00
|
|
|
var sshInstance = new smartssh.sshInstance({
|
2018-09-17 20:32:31 +00:00
|
|
|
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;
|
2016-04-25 03:06:39 +00:00
|
|
|
});
|
|
|
|
|
|
2018-09-17 20:32:31 +00:00
|
|
|
sshInstance.addKey(
|
|
|
|
|
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
|
|
|
|
|
})
|
|
|
|
|
);
|
2016-04-25 03:24:10 +00:00
|
|
|
|
2018-09-17 20:32:31 +00:00
|
|
|
sshInstance.removeKey(sshInstance.getKey('github.com')); // removes key for host "github.com" is present
|
2016-04-26 02:44:50 +00:00
|
|
|
|
2016-04-25 03:24:10 +00:00
|
|
|
sshInstance.createKey({
|
2018-09-17 20:32:31 +00:00
|
|
|
host: 'gitlab.com' // returns new key in the form sshKey, read more about the sshKey class below
|
2016-04-25 03:06:39 +00:00
|
|
|
});
|
|
|
|
|
|
2018-09-17 20:32:31 +00:00
|
|
|
sshInstance.getKey({
|
|
|
|
|
// returns ssh key in the form sshKey, read more about the sshKey class below
|
|
|
|
|
host: 'github.com'
|
|
|
|
|
});
|
2016-04-25 03:24:10 +00:00
|
|
|
|
2018-09-17 20:32:31 +00:00
|
|
|
sshInstance.getKeys(); // returns array of all available getKeys. Each key is in form of class sshKey
|
2016-04-26 02:44:50 +00:00
|
|
|
```
|
2016-11-23 11:44:31 +00:00
|
|
|
|
|
|
|
|
[](https://push.rocks)
|
