Skip to content
Like child_process.spawn but with sudo
JavaScript
Find file
Latest commit 0c07c78 Jan 20, 2016 @calmh Merge pull request #5 from hikouki/master
Added option for sudo password
Failed to load latest commit information.
lib Add password option. Jan 18, 2016
.gitignore
LICENSE
README.md Add password option in Readme.md Jan 18, 2016
package.json 1.0.3 Oct 29, 2012

README.md

node-sudo

A child_process.spawn but with sudo in between. The sudo password dialog is abstracted away so that the calling Node script can interact with the program that is run under sudo without worrying about it.

Synopsis

sudo(args, options)
  • args: An array of arguments to sudo. Can be both options (such as -v or -E) and the program to run. Example: ['ls'].

  • options: An optional object containing options. Recognized options are:

    • password: String; sudo password.

    • cachePassword: Boolean; whether to remember the password between invocations or not.

    • prompt: String; what to display to the user when the password is needed.

    • spawnOptions: Object; passed on directly to spawn. stdio or customFds will be overwritten.

Example

var sudo = require('sudo');
var options = {
    cachePassword: true,
    prompt: 'Password, yo? ',
    spawnOptions: { /* other options for spawn */ }
};
var child = sudo([ 'ls', '-l', '/tmp' ], options);
child.stdout.on('data', function (data) {
    console.log(data.toString());
});

License

MIT

Something went wrong with that request. Please try again.