re:re:actable
Урок 021 минута чтения

Как читать аргументы командной строки?

На этой странице
Кратко

Аргументы командной строки в Node.js доступны через process.argv. Это массив строк, где первые два элемента обычно путь к Node.js и путь к запускаемому файлу, а пользовательские аргументы начинаются с индекса 2.

Вопрос

Как читать аргументы командной строки в Node.js?

Базовый пример

Запуск:

node cli.js create user

Код:

console.log(process.argv);

Примерный результат:

[
  'C:\\Program Files\\nodejs\\node.exe',
  'C:\\project\\cli.js',
  'create',
  'user'
]

Поэтому часто делают так:

const [, , command, entity] = process.argv;
 
console.log(command); // create
console.log(entity); // user

Простая CLI-команда

const [, , name] = process.argv;
 
if (!name) {
  console.error('Укажи имя: node greet.js Анна');
  process.exitCode = 1;
} else {
  console.log(`Привет, ${name}!`);
}

Флаги

node build.js --mode production --watch
const args = process.argv.slice(2);
 
const hasWatch = args.includes('--watch');
const modeIndex = args.indexOf('--mode');
const mode = modeIndex === -1 ? 'development' : args[modeIndex + 1];
 
console.log({ hasWatch, mode });

Для сложных CLI обычно берут библиотеки вроде commander, yargs или cac.

Что важно помнить

  • process.argv[0] — путь к node, [1] — путь к скрипту, аргументы начинаются с индекса 2.
  • Встроенный util.parseArgs разбирает флаги без сторонних библиотек.
  • Для сложных CLI используют commander или yargs.
  • Все значения аргументов — строки: приводите типы и валидируйте.

Мини-шпаргалка

  • process.argv - все аргументы запуска.
  • Пользовательские аргументы начинаются с process.argv[2].
  • slice(2) часто используют для CLI.
  • Для сложных флагов лучше подключить CLI-библиотеку.
  • Ошибочное завершение обозначают process.exitCode = 1.

Документация

Node.js: process.argv, Node.js: util.parseArgs.

Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.

Поиск

Поиск по урокам