ssh2-exec

Node.js ssh2-exec

The Node.js ssh2-exec package extends the ssh2 module to provide transparent usage between the child_process.exec and ssh2.prototype.exec functions.

Installation

This is OSS and licensed under the new BSD license.

npm install ssh2-exec

Usage

Requiring the module export a single function expecting 1, 2 or 3 arguments. The function signature is exec([command], options, [callback]).

Like in the native NodeJS API, the callback is not required in case you with to work with the returned child stream. The command argument is also facultative since it could be provided under the "cmd" property of the options object.

Valid options properties are:

• ssh SSH connection if the command must run remotely
• cmd Command to run unless provided as first argument
• cwd Current working directory
• end Close the SSH connection on exit, default to true if an ssh connection instance is provided.
• env An environment to use for the execution of the command.
• pty Set to true to allocate a pseudo-tty with defaults, or an object containing specific pseudo-tty settings. Apply only to SSH remote commands.
• cwd Apply only to local commands.
• uid Apply only to local commands.
• gid Apply only to local commands.

Valid options.ssh properties are:

• username SSH user
• privateKey String representing the private key, required when no password is provided and no private is found
• privateKeyPath Path from where to read the private key, default to "~/.ssh/id_rsa"
• port SSH port, default to 22
• password SSH password, required when no private key is provided or found

Examples

A command, a configuration object and a callback:

connect = require('ssh2-connect');
exec = require('ssh2-exec');
connect({host: localhost}, function(err, ssh){
  exec('ls -la', {ssh: ssh}, (err, stdout, stderr){
    console.log(stdout);
  });
});

A configuration object with a ssh2 connection and working a the return child object:

connect = require('ssh2-connect');
exec = require('ssh2-exec');
connect({host: localhost}, function(err, ssh){
  child = exec({cmd: 'ls -la', ssh: ssh}, function(err, stdout, stderr){
    console.log(stdout);
  });
  child.stdout.on('data', function(data){
    console.log(stdout);
  });
  child.on('exit', function(code){
    console.log('Exit', code);
  });
})

Development

Tests are executed with mocha. To install it, simple run npm install, it will install mocha and its dependencies in your project "node_modules" directory.

To run the tests:

npm test

The tests run against the CoffeeScript source files.

To generate the JavaScript files:

make build

The test suite is run online with Travis against Node.js version 0.6, 0.7, 0.8 and 0.9.

Contributors

• David Worms: https://github.com/wdavidw