# ssh-utils

> SSH utilities, promise based, simple to use

Latest version **1.0.3** (published 2016-11-13) · ISC license · 0 weekly downloads

## Install

```sh
npm install ssh-utils
pnpm add ssh-utils
yarn add ssh-utils
bun add ssh-utils
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2016-11-13 |
| First published | 2016-09-29 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | raoul2000 |
| Maintainers | raoul2000 |
| Keywords | ssh, promise |

## Links

- npm: https://www.npmjs.com/package/ssh-utils
- Repository: https://github.com/raoul2000/ssh-utils
- Issues: https://github.com/raoul2000/ssh-utils/issues
- npm.io page: https://npm.io/package/ssh-utils

## Dependencies (2)

- [q](https://npm.io/package/q.md) ^1.4.1
- [ssh2](https://npm.io/package/ssh2.md) ^0.5.2

## Alternatives

- [promise-throttle](https://npm.io/package/promise-throttle.md) — 44.2K weekly downloads
- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2016-11-13
- 1.0.2 — 2016-10-09
- 1.0.1 — 2016-09-29
- 1.0.0 — 2016-09-29

## README

THIS IS A WORK IN PROGRESS

a nodejs module to help work with SSH

# Install

```
npm install ssh-utils
```

# Usage

```js
"use strict";

var execCmd = require('ssh-utils').exec.command;
var catFile = require('ssh-utils').readFileContent;

var cnx = {
    "host": "127.0.0.1",
    "username": "bobMarley",
    "password": "ja"
};

execCmd(cnx, 'ls -l')
.then(function(result){
  console.log(result);
  return catFile(cnx,'/etc/hosts')
  .then(function(hosts){
    console.log(hosts);
  })
  .fail(function(err){
    console.log("1. error");
    console.log(err);
  });
})
.fail(function(err){
  console.log("2. error");
  console.log(err);
});
```

---
_Source: https://npm.io/package/ssh-utils · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
