exec-sh
Last updated
Last updated
Execute shell command forwarding all stdio streams.
exec-sh is a wrapper for child_process.spawn
with some improvements:
Cross platform command execution:
Windows: cmd /C COMMAND
others: sh -c COMMAND
Fowrards all stdio streams to current terminal (by default):
execSh("bash")
execsh("echo -n Say: && read i && echo Said:$i")
stdout and stderr are passed to callback when available
execSh("pwd", console.log)
execSh(command, [options], [callback])
Execute shell command forwarding all stdio.
Parameters:
command {String|Array}
- The command to run, or array of commands
[options] {Object|TRUE}
- Options object passed directly to child_process.spawn
, when TRUE
then { stdio: null }
used
[callback] {Function}
- callback(err, stdout, stderr)
err {Error|NULL}
- Error object. Has code
property containing last command exit code when available
stdout {String|NULL}
- aggregated stdout or NULL
if not available
stderr {String|NULL}
- aggregated stderr or NULL
if not available
Return Values:
Returns ChildProcess object.
Complete API Documentation including private and public methods is generated from source code by JSDoc tool and is available here.
Code coverage report for all files is available here.
npm test
- run tests
npm run jsdoc
- build jsdoc
npm run dev
- run tests continuously
The MIT License (MIT)