2019-07-17 09:48:31 +00:00
|
|
|
# @pushrocks/smartssh
|
2016-04-25 03:06:39 +00:00
|
|
|
setups SSH quickly and in a painless manner
|
|
|
|
|
2019-07-17 09:48:31 +00:00
|
|
|
## Availabililty and Links
|
|
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartssh)
|
|
|
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartssh)
|
|
|
|
* [github.com (source mirror)](https://github.com/pushrocks/smartssh)
|
|
|
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartssh/)
|
2016-11-23 11:44:31 +00:00
|
|
|
|
|
|
|
## Status for master
|
|
|
|
[![build status](https://gitlab.com/pushrocks/smartssh/badges/master/build.svg)](https://gitlab.com/pushrocks/smartssh/commits/master)
|
|
|
|
[![coverage report](https://gitlab.com/pushrocks/smartssh/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartssh/commits/master)
|
2019-07-17 09:48:31 +00:00
|
|
|
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartssh.svg)](https://www.npmjs.com/package/@pushrocks/smartssh)
|
|
|
|
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartssh/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartssh)
|
|
|
|
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
|
|
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
|
|
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
|
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
|
|
|
|
2019-07-17 09:48:31 +00:00
|
|
|
For further information read the linked docs at the top of this readme.
|
|
|
|
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
|
|
|
|
|
|
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
|