sudo-prompt/README.md

26 lines
784 B
Markdown
Raw Normal View History

2015-06-08 15:24:56 +02:00
# Sudo
Run a command using sudo, prompting the user with an OS dialog if necessary.
Currently supports native OS dialog on Mac OS X (patches welcome for Linux).
Sudo has no external dependencies and does not contain any native bindings.
## Usage
Note that your command should not contain the sudo prefix.
```
// To run a command using sudo:
var sudo = require('sudo-prompt');
sudo.exec('echo hello', function(error) {});
// To update the sudo timestamp for the current user:
sudo.touch(function(error) {});
// To use something other than process.title as the app name:
// Must be alphanumeric (may contain spaces).
sudo.setName('Your app name')
```
## Concurrency
You can call Sudo.exec and Sudo.touch concurrently, Sudo will batch up permission requests into a single prompt.