LBRYCommunity/sudo-prompt
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Joran Dirk Greef 2015-08-05 09:10:34 +02:00
parent 8636d2e5bb
commit 73b17830d0
1 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,4 +1,4 @@
# Sudo
## sudo-prompt
Run a command using sudo, prompting the user with an OS dialog if necessary. Useful for background applications or native Electron apps that need sudo.
@ -6,16 +6,23 @@ Run a command using sudo, prompting the user with an OS dialog if necessary. Use
Currently supports native OS dialog prompt on Mac OS X (patches welcome for Linux) and uses process.title as the name of the app requesting permission.
Sudo has no external dependencies and does not contain any native bindings.
sudo-prompt has no external dependencies and does not require any native bindings.
## Installation
```
npm install sudo-prompt
```
## Usage
Note: Your command should not start with the "sudo" prefix.
```
// To run a command using sudo:
// To run a command using sudo-prompt:
var sudo = require('sudo-prompt');
sudo.exec('echo hello', function(error) {});
// To update the sudo timestamp for the current user:
// This will extend any existing sudo session for a few more minutes.
// It will prompt to create a new session if there is no existing sudo session.
sudo.touch(function(error) {});
// To use something other than process.title as the app name:
@ -23,5 +30,8 @@ sudo.touch(function(error) {});
sudo.setName('Your app name')
```
## Behavior
sudo-prompt should behave just like the `sudo` command in the shell. If your command does not work with the `sudo` command in the shell (perhaps because it uses `>` redirection to a restricted file), then it will not work with sudo-prompt. However, it is still possible to use sudo-prompt to get a privileged shell, [see this issue for more information](https://github.com/jorangreef/sudo/issues/1).
## Concurrency
You can call `sudo.exec` and `sudo.touch` concurrently, Sudo will batch up permission requests into a single prompt.