https://github.com/mafintosh/ssh-exec

Execute a script over ssh using Node.JS
https://github.com/mafintosh/ssh-exec

Last synced: 30 days ago
JSON representation

Execute a script over ssh using Node.JS

• Host: GitHub
• URL: https://github.com/mafintosh/ssh-exec
• Owner: mafintosh
• License: mit
• Created: 2013-11-20T10:44:24.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2020-06-20T17:21:53.000Z (over 4 years ago)
• Last Synced: 2024-11-10T20:05:24.610Z (about 1 month ago)
• Language: JavaScript
• Size: 26.4 KB
• Stars: 126
• Watchers: 7
• Forks: 25
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ssh-exec

Execute a script over ssh using Node.JS and pipe to and from it

It is available through npm

```

npm install ssh-exec

```

It is written in plain Javascript and uses [ssh2](https://github.com/mscdex/ssh2) for all the heavy lifting.

## Usage

``` js

var exec = require('ssh-exec')

// using ~/.ssh/id_rsa as the private key

exec('ls -lh', '[email protected]').pipe(process.stdout)

// or using the more settings

exec('ls -lh', {

  user: 'ubuntu',

  host: 'my-remote.com',

  key: myKeyFileOrBuffer,

  password: 'my-user-password'

}).pipe(process.stdout)

// or if you want to pipe some data to the remote process

process.stdin

  .pipe(exec('echo try typing something; cat -', '[email protected]'))

  .pipe(process.stdout)

```

Optionally there is a callback api as well

``` js

exec('ls -lh', '[email protected]', function (err, stdout, stderr) {

  console.log(err, stdout, stderr)

})

```

## License

MIT