57 lines
2.6 KiB
Markdown
57 lines
2.6 KiB
Markdown
# @pushrocks/smartssh
|
|
setups SSH quickly and in a painless manner
|
|
|
|
## 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/)
|
|
|
|
## Status for master
|
|
[](https://gitlab.com/pushrocks/smartssh/commits/master)
|
|
[](https://gitlab.com/pushrocks/smartssh/commits/master)
|
|
[](https://www.npmjs.com/package/@pushrocks/smartssh)
|
|
[](https://snyk.io/test/npm/@pushrocks/smartssh)
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
[](https://prettier.io/)
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
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;
|
|
});
|
|
|
|
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
|
|
})
|
|
);
|
|
|
|
sshInstance.removeKey(sshInstance.getKey('github.com')); // removes key for host "github.com" is present
|
|
|
|
sshInstance.createKey({
|
|
host: 'gitlab.com' // returns new key in the form sshKey, read more about the sshKey class below
|
|
});
|
|
|
|
sshInstance.getKey({
|
|
// 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](https://lossless.gmbh)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
|
|
[](https://maintainedby.lossless.com)
|