se

ssh-exec

Execute a script over ssh using Node.JS

Showing:

Popularity

Downloads/wk

3.6K

GitHub Stars

121

Maintenance

Last Commit

6yrs ago

Contributors

3

Package

Dependencies

3

Size (min+gzip)

65.2KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

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 for all the heavy lifting.

Usage

var exec = require('ssh-exec')

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

exec('ls -lh', 'ubuntu@my-remote.com').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 -', 'ubuntu@my-remote.com'))
  .pipe(process.stdout)

Optionally there is a callback api as well

exec('ls -lh', 'ubuntu@my-remote.com', function (err, stdout, stderr) {
  console.log(err, stdout, stderr)
})

License

MIT

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial