Execute a command line binary with Node.js

For even newer version of Node.js (v8.1.4), the events and calls are similar or identical to older versions, but it's encouraged to use the standard newer language features. Examples:

For buffered, non-stream formatted output (you get it all at once), use child_process.exec:

const { exec } = require('child_process');exec('cat *.js bad_file | wc -l', (err, stdout, stderr) => {  if (err) {    // node couldn't execute the command    return;  }  // the *entire* stdout and stderr (buffered)  console.log(`stdout: ${stdout}`);  console.log(`stderr: ${stderr}`);});

You can also use it with Promises:

const util = require('util');const exec = util.promisify(require('child_process').exec);async function ls() {  const { stdout, stderr } = await exec('ls');  console.log('stdout:', stdout);  console.log('stderr:', stderr);}ls();

If you wish to receive the data gradually in chunks (output as a stream), use child_process.spawn:

const { spawn } = require('child_process');const child = spawn('ls', ['-lh', '/usr']);// use child.stdout.setEncoding('utf8'); if you want text chunkschild.stdout.on('data', (chunk) => {  // data from standard output is here as buffers});// since these are streams, you can pipe them elsewherechild.stderr.pipe(dest);child.on('close', (code) => {  console.log(`child process exited with code ${code}`);});

Both of these functions have a synchronous counterpart. An example for child_process.execSync:

const { execSync } = require('child_process');// stderr is sent to stderr of parent process// you can set options.stdio if you want it to go elsewherelet stdout = execSync('ls');

As well as child_process.spawnSync:

const { spawnSync} = require('child_process');const child = spawnSync('ls', ['-lh', '/usr']);console.log('error', child.error);console.log('stdout ', child.stdout);console.log('stderr ', child.stderr);

Note: The following code is still functional, but is primarily targeted at users of ES5 and before.

The module for spawning child processes with Node.js is well documented in the documentation (v5.0.0). To execute a command and fetch its complete output as a buffer, use child_process.exec:

var exec = require('child_process').exec;var cmd = 'prince -v builds/pdf/book.html -o builds/pdf/book.pdf';exec(cmd, function(error, stdout, stderr) {  // command output is in stdout});

If you need to use handle process I/O with streams, such as when you are expecting large amounts of output, use child_process.spawn:

var spawn = require('child_process').spawn;var child = spawn('prince', [  '-v', 'builds/pdf/book.html',  '-o', 'builds/pdf/book.pdf']);child.stdout.on('data', function(chunk) {  // output will be here in chunks});// or if you want to send output elsewherechild.stdout.pipe(dest);

If you are executing a file rather than a command, you might want to use child_process.execFile, which parameters which are almost identical to spawn, but has a fourth callback parameter like exec for retrieving output buffers. That might look a bit like this:

var execFile = require('child_process').execFile;execFile(file, args, options, function(error, stdout, stderr) {  // command output is in stdout});

As of v0.11.12, Node now supports synchronous spawn and exec. All of the methods described above are asynchronous, and have a synchronous counterpart. Documentation for them can be found here. While they are useful for scripting, do note that unlike the methods used to spawn child processes asynchronously, the synchronous methods do not return an instance of ChildProcess.

Node JS v15.8.0, LTS v14.15.4, and v12.20.1 --- Feb 2021

Async method (Unix):

'use strict';const { spawn } = require( 'child_process' );const ls = spawn( 'ls', [ '-lh', '/usr' ] );ls.stdout.on( 'data', ( data ) => {    console.log( `stdout: ${ data }` );} );ls.stderr.on( 'data', ( data ) => {    console.log( `stderr: ${ data }` );} );ls.on( 'close', ( code ) => {    console.log( `child process exited with code ${ code }` );} );

Async method (Windows):

'use strict';const { spawn } = require( 'child_process' );// NOTE: Windows Users, this command appears to be differ for a few users.// You can think of this as using Node to execute things in your Command Prompt.// If `cmd` works there, it should work here.// If you have an issue, try `dir`:// const dir = spawn( 'dir', [ '.' ] );const dir = spawn( 'cmd', [ '/c', 'dir' ] );dir.stdout.on( 'data', ( data ) => console.log( `stdout: ${ data }` ) );dir.stderr.on( 'data', ( data ) => console.log( `stderr: ${ data }` ) );dir.on( 'close', ( code ) => console.log( `child process exited with code ${code}` ) );

Sync:

'use strict';const { spawnSync } = require( 'child_process' );const ls = spawnSync( 'ls', [ '-lh', '/usr' ] );console.log( `stderr: ${ ls.stderr.toString() }` );console.log( `stdout: ${ ls.stdout.toString() }` );

From Node.js v15.8.0 Documentation

The same goes for Node.js v14.15.4 Documentation and Node.js v12.20.1 Documentation

You are looking for child_process.exec

Here is the example:

const exec = require('child_process').exec;const child = exec('cat *.js bad_file | wc -l',    (error, stdout, stderr) => {        console.log(`stdout: ${stdout}`);        console.log(`stderr: ${stderr}`);        if (error !== null) {            console.log(`exec error: ${error}`);        }});