Skip to content

parro-it/spawn-shell

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

64 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

spawn-shell

Greenkeeper badge Travis Build Status NPM module NPM downloads

Run shell commands using child_process#spawn.

Features

  • Multi-platform - run on OSX, Linux, Windows
  • Return a promise that resolve with exitcode when spawned process terminetes
  • Use child_process#spawn for greater flexibility than child_process#exec
  • Use user system shell by default, or customize it via shell option.
  • Inject your package node_modules/.bin directory in path.
  • stdio spawn option defaults to inherit, sharing parent process stdin & stdout

Installation

npm install --save spawn-shell

Usage

  const spawnShell = require('spawn-shell');

  // simple to use with promise
  const exitCode = await spawnShell('echo "it works" && exit 42').exitPromise;
  // output `it works` to stdout
  // exitCode === 42


  // access ChildProcess instance before promise is resolved
  const p = spawnShell('echo "it works"', {
    stdio: [0, 'pipe', 2]
  });

  p.stdout.pipe(concat(
    {encoding: 'string'},
    output => {
      // output === 'it works'
    }
  ));

License

The MIT License (MIT)

Copyright (c) 2017 parro-it

About

Run shell commands using child_process#spawn.

Resources

License

Stars

Watchers

Forks

Packages

No packages published