any-shell-escape

Escape and stringify an array of arguments to be executed on the shell

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
any-shell-escape
1240.1.19 years ago9 years agoMinified + gzip package size for any-shell-escape in KB

Readme

shell-escape
Escape and stringify an array of arguments to be executed on the shell

Install

npm install shell-escape

Example

simple

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

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