process.argv
是 Node.js 提供的一个数组,用于获取命令行参数。以下是详细的教程,介绍如何使用 process.argv
获取和处理命令行参数。
1. 基本使用
当你运行一个 Node.js 脚本时,可以通过命令行传递参数。例如:
node script.js arg1 arg2 arg3
在 script.js
文件中,你可以通过 process.argv
访问这些参数:
// script.js
console.log(process.argv);
运行上面的命令会输出:
[
'/path/to/node', // process.argv[0]
'/path/to/script.js', // process.argv[1]
'arg1', // process.argv[2]
'arg2', // process.argv[3]
'arg3' // process.argv[4]
]
2. 解析参数
通常,我们只对实际的命令行参数感兴趣,而不需要 Node.js 可执行文件路径和脚本文件路径。我们可以通过 process.argv.slice(2)
来获取这些实际参数:
// script.js
const args = process.argv.slice(2);
console.log(args);
运行 node script.js arg1 arg2 arg3
会输出:
[ 'arg1', 'arg2', 'arg3' ]
3. 使用参数
你可以根据自己的需求来处理这些参数。例如:
// script.js
const args = process.argv.slice(2);
args.forEach((arg, index) => {
console.log(`Argument ${
index + 1}: ${
arg}`);
});
运行 node script.js arg1 arg2 arg3
会输出:
Argument 1: arg1
Argument 2: arg2
Argument 3: arg3
4. 处理选项和标志
在实际应用中,命令行参数通常包括选项和标志。你可以手动解析这些参数,或者使用第三方库如 minimist
或 yargs
。
手动解析
// script.js
const args = process.argv.slice(2);
let options = {
};
let currentOption = null;
args.forEach(arg => {
if (arg.startsWith('--')) {
currentOption = arg.substring(2);
options[currentOption] = true; // 默认值为 true
} else {
if (currentOption) {
options[currentOption] = arg;
currentOption = null;
}
}
});
console.log(options);
运行 node script.js --name John --age 30 --developer
会输出:
{
name: 'John',
age: '30',
developer: true
}
使用 minimist
你可以使用 minimist
库来简化参数解析:

npm install minimist
// script.js
const minimist = require('minimist');
const args = minimist(process.argv.slice(2));
console.log(args);
运行 node script.js --name John --age 30 --developer
会输出:
{
_: [],
name: 'John',
age: 30,
developer: true
}
使用 yargs
yargs
是另一个强大的命令行参数解析库:
npm install yargs
// script.js
const yargs = require('yargs/yargs');
const {
hideBin } = require('yargs/helpers');
const argv = yargs(hideBin(process.argv)).argv;
console.log(argv);
运行 node script.js --name John --age 30 --developer
会输出:
{
_: [],
name: 'John',
age: 30,
developer: true,
'$0': 'script.js'
}
总结
process.argv
是一个强大的工具,用于在 Node.js 中获取和处理命令行参数。通过 process.argv.slice(2)
可以获取实际传递的参数,并可以手动解析或使用第三方库如 minimist
和 yargs
来简化参数的处理。根据你的需求选择合适的方法来处理命令行参数。