Subtheme of barrio
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

61 lines
1.0 KiB

2 years ago
shell-escape
============
Escape and stringify an array of arguments to be executed on the shell
Install
-------
npm install shell-escape
Example
-------
### simple
``` js
var shellescape = require('shell-escape');
var args = ['curl', '-v', '-H', 'Location;', '-H', 'User-Agent: dave#10', 'http://www.daveeddy.com/?name=dave&age=24'];
var escaped = shellescape(args);
console.log(escaped);
```
yields
```
curl -v -H 'Location;' -H 'User-Agent: dave#10' 'http://www.daveeddy.com/?name=dave&age=24'
```
A command suitable for being executed by the shell
### advanced
``` js
var shellescape = require('shell-escape');
var args = ['echo', 'hello!', 'how are you doing $USER', '"double"', "'single'"];
var escaped = shellescape(args);
console.log(escaped);
```
yields
```
echo 'hello!' 'how are you doing $USER' '"double"' \''single'\'
```
and when run on the shell
```
$ echo 'hello!' 'how are you doing $USER' '"double"' \''single'\'
hello! how are you doing $USER "double" 'single'
```
License
-------
MIT