exec for running shell commands in Node.js - Mini Project: Build & Apply

Using exec to Run Shell Commands in Node.js

📖 Scenario: You are building a simple Node.js script that runs a shell command to list files in a folder. This is useful when you want your program to interact with the system shell to get information or run tools.

🎯 Goal: Create a Node.js script that uses exec from the child_process module to run the ls -l command and handle its output.

📋 What You'll Learn

Import the exec function from the child_process module

Create a variable command with the exact string ls -l

Use exec to run the command variable

Handle the callback to print the command output or error

💡 Why This Matters

🌍 Real World

Running shell commands from Node.js scripts helps automate system tasks, gather system info, or run external tools.

💼 Career

Many backend developers use exec to integrate system commands or scripts into their Node.js applications.

1

Import exec from child_process

Write a line to import exec from the child_process module using destructuring assignment.

Node.js

// Your code here

Hint

Use const { exec } = require('child_process'); to import exec.

2

Create the command variable

Create a variable called command and set it to the string 'ls -l'.

Node.js

const { exec } = require('child_process');
// Your code here

Hint

Use const command = 'ls -l'; to store the shell command.

3

Run the command with exec

Use exec to run the command variable. Provide a callback with parameters error, stdout, and stderr.

Node.js

const { exec } = require('child_process');
const command = 'ls -l';
// Your code here

Hint

Call exec(command, (error, stdout, stderr) => { ... }) to run the command.

4

Handle output and errors

Inside the exec callback, add code to check if error exists. If yes, return early. Otherwise, log stdout to the console.

Node.js

const { exec } = require('child_process');
const command = 'ls -l';

exec(command, (error, stdout, stderr) => {
  // Your code here
});

Hint

Use if (error) { return; } to stop on error, then console.log(stdout); to show output.

Practice

1. What does the exec function in Node.js primarily do?

easy

A. Runs shell commands from within a Node.js program

B. Creates a new HTTP server

C. Reads files from the filesystem

D. Starts a database connection

Solution

1. Step 1: Understand the purpose of exec

   The exec function is designed to run shell commands from Node.js code.

2. Step 2: Compare with other options

   Creating servers, reading files, or database connections are unrelated to exec.

3. Final Answer:

   Runs shell commands from within a Node.js program -> Option A

4. Quick Check:

   exec runs shell commands = B [OK]

Hint: Remember exec runs shell commands, not servers or files [OK]

Common Mistakes:

• Confusing exec with file reading functions
• Thinking exec creates servers
• Assuming exec manages databases

2. Which is the correct way to import and use exec from the child_process module in Node.js?

easy

A. import exec from 'child_process';

B. const exec = require('child_process').exec;

C. const exec = require('exec');

D. import { exec } from 'child_process';

Solution

1. Step 1: Recall Node.js import syntax for exec

   In Node.js CommonJS, exec is imported as const exec = require('child_process').exec;.

2. Step 2: Check other options for correctness

   import exec from 'child_process'; uses ES module default import incorrectly; const exec = require('exec'); tries to require a non-existent module; import { exec } from 'child_process'; is ES module named import but Node.js needs special config.

3. Final Answer:

   const exec = require('child_process').exec; -> Option B

4. Quick Check:

   CommonJS import for exec = A [OK]

Hint: Use require('child_process').exec for standard Node.js [OK]

Common Mistakes:

• Using import without Node.js ES module setup
• Requiring wrong module name
• Confusing default and named imports

3. What will the following Node.js code output if the current directory contains a file named test.txt?

const { exec } = require('child_process');
exec('ls', (error, stdout, stderr) => {
  if (error) {
    console.error(`Error: ${error.message}`);
    return;
  }
  if (stderr) {
    console.error(`Stderr: ${stderr}`);
    return;
  }
  console.log(`Output: ${stdout}`);
});

medium

A. Output: test.txt

B. Error: ls command not found

C. Stderr: Permission denied

D. No output

Solution

1. Step 1: Understand exec running 'ls'

   The command ls lists files in the current directory. If test.txt exists, it will appear in the output.

2. Step 2: Analyze callback behavior

   No error or stderr means output is printed with file names, so console logs 'Output: test.txt\n'.

3. Final Answer:

   Output: test.txt -> Option A

4. Quick Check:

   exec runs ls, outputs files = A [OK]

Hint: exec callback logs stdout if no error or stderr [OK]

Common Mistakes:

• Assuming error if command runs successfully
• Ignoring stdout content
• Confusing stderr with stdout

4. Identify the error in this Node.js code using exec:

const { exec } = require('child_process');
exec('node -v', (error, stdout, stderr) => {
  if (error) {
    console.log(error);
  }
  console.log(stdout);
});

medium

A. Callback function has wrong parameters

B. Incorrect command syntax for node version

C. Missing error return causes stdout to print even on error

D. exec is not imported correctly

Solution

1. Step 1: Check error handling logic

   The code logs error but does not return or stop, so stdout logs even if error occurs.

2. Step 2: Understand impact of missing return

   This can cause confusing output mixing error and stdout, which is not ideal.

3. Final Answer:

   Missing error return causes stdout to print even on error -> Option C

4. Quick Check:

   Missing error return causes stdout to print even on error = D [OK]

Hint: Return after error to avoid printing stdout [OK]

Common Mistakes:

• Not returning after error check
• Assuming exec import is wrong
• Thinking command syntax is incorrect

5. You want to run a shell command that lists all files but only print those containing the word 'log'. Which exec usage correctly achieves this in Node.js?

hard

A. exec('ls > grep log', (err, stdout) => { if (!err) console.log(stdout); });

B. exec('ls && grep log', (err, stdout) => { if (!err) console.log(stdout); });

C. exec('ls | find log', (err, stdout) => { if (!err) console.log(stdout); });

D. exec('ls | grep log', (err, stdout) => { if (!err) console.log(stdout); });

Solution

1. Step 1: Understand shell command chaining

   The pipe | sends output of ls to grep log to filter lines containing 'log'.

2. Step 2: Evaluate each option's command

   ls | grep log correctly pipes output to grep for filtering; ls > grep log uses redirection to create a file; ls && grep log runs sequentially without piping; ls | find log pipes to filesystem search tool unsuitable for text filtering.

3. Final Answer:

   exec('ls | grep log', (err, stdout) => { if (!err) console.log(stdout); }); -> Option D

4. Quick Check:

   Pipe output to grep for filtering = C [OK]

Hint: Use pipe (|) to filter command output with grep [OK]

Common Mistakes:

• Using && instead of | for piping output
• Misusing redirection operators
• Confusing grep with find command