How can you read command-line arguments in a Node.js application?

Reading command line arguments in Node.js applications is a highly practical feature that allows programs to receive external input at startup, making them more flexible and configurable. Node.js provides several methods for reading command line arguments, and I will detail the most commonly used approaches below.

Using process.argv

process.argv is a string array containing command line arguments. The first element is 'node', the second is the path to the JavaScript file being executed, and the remaining elements are additional command line arguments. We can retrieve the required parameters by iterating through this array.

Example Code

Suppose we have a script example.js that needs to receive user input via the command line:

javascript
// example.js
// Run command: node example.js user1 password123

const args = process.argv.slice(2); // Remove the first two elements

console.log('Username:', args[0]); // Output: Username: user1
console.log('Password:', args[1]); // Output: Password: password123

This method is straightforward, but it may become insufficient when dealing with numerous command line arguments or more complex parsing requirements.

Using Third-Party Library: yargs

For more complex command line argument parsing, we can use third-party libraries like yargs, which provides powerful command line argument parsing capabilities, supporting features such as default values, aliases, and command prompts.

Example Code

Install yargs:

bash
npm install yargs

Use yargs to parse command line arguments:

javascript
// example.js
// Run command: node example.js --username user1 --password password123

const argv = require('yargs').argv;

console.log('Username:', argv.username); // Output: Username: user1
console.log('Password:', argv.password); // Output: Password: password123

By using yargs, we can handle complex command line arguments more easily and make the code more maintainable and extensible.

Summary

Reading command line arguments is a fundamental way to handle external input in Node.js. Depending on the complexity of your requirements, you can choose between the simple process.argv or the more comprehensive yargs library. For simple scenarios, process.argv is sufficient; however, for applications requiring more features and better user experience, yargs provides a richer solution.