Skip to content

ipburger/ssh-exec.js

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

70 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ssh-exec

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

npm install git+https://github.com/ipburger/ssh-exec.js.git

This fork merges the most helpful commits across github on ssh-exec

Latest Fixes

  • Occasional truncated stdout
  • ssh agent forwarding

Usage

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

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

Options

Look at the source.

License

MIT

About

Execute a script over ssh using Node.JS

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 94.4%
  • Shell 5.6%