Node.js provides a child_process module that provides the ability to spawn child processes.

Import or require the module, and get the spawn function from it:

const { spawn } = require('child_process')

Then you can call spawn() passing 2 parameters.

The first parameter is the command to run.

The second parameter is an array of arguments to pass to the command.

Here’s an example:

spawn('ls', ['-lh', 'test'])

In this case you run the ls command with 2 options: -lh and test. This results in the command ls -lh test, which (if the test file exists in the directory you run the script from) results in the details about the file:

-rw-r--r--  1 flaviocopes  staff     6B Sep 25 09:57 test

The result of the spawn() function call is an instance of the ChildProcess class that identifies the spawned child process.

Here’s a slightly more complicated example, fully working. We watch the test file and whenever it’s changed, we run the ls -lh command on it:

'use strict'

const fs = require('fs')
const { spawn } = require('child_process')
const filename = 'test'

fs.watch(filename, () => {
  const ls = spawn('ls', ['-lh', filename])
})

There’s one thing missing. We must pipe the output from the child process to the main process, otherwise we won’t see any output from it.

We do so by calling the pipe() method on the stdout property of the child process:

'use strict'

const fs = require('fs')
const { spawn } = require('child_process')
const filename = 'test'

fs.watch(filename, () => {
  const ls = spawn('ls', ['-lh', filename])
  ls.stdout.pipe(process.stdout)
})

Lessons in this unit:

0:	Introduction
1:	How to execute a shell command using Node.js
2:	▶︎ How to spawn a child process with Node.js
3:	Node, accept arguments from the command line
4:	Accept input from the command line in Node
5:	How to log an object in Node
6:	Output to the command line using Node
7:	How to exit from a Node.js program