Параметры командной строки

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

Чтобы просмотреть это руководство в виде страницы справки в терминале, выполните man node.

Синтаксис

node [options] [v8 options] [script.js | -e "script"] [--] [arguments]

node debug [script.js | -e "script" | <host>:<port>] …

node --v8-options

Выполните без аргументов, чтобы запустить REPL.

Для получения дополнительной информации о node debug, см. документацию по отладчику.

Параметры

-v, --version

Выводит версию node.

-h, --help

Выводит параметры командной строки node. Вывод этого параметра менее подробен, чем этот документ.

-e, --eval "script"

Вычисляет следующий аргумент как JavaScript. Модули, предварительно определённые в REPL, также могут использоваться в script.

Примечание: В Windows использование cmd.exe одинарной кавычки не будет работать должным образом, так как распознаются только двойные " для цитирования. В Powershell или Git bash можно использовать как ', так и ".

-p, --print "script"

Идентично -e но выводит результат.

-c, --check

Проверка синтаксиса скрипта без выполнения.

-i, --interactive

Открывает REPL, даже если stdin не кажется терминалом.

-r, --require module

Загружает указанный модуль при запуске.

Следует require() правилам разрешения модулей. module может быть либо путем к файлу, либо именем модуля node.

--no-deprecation

Отключает предупреждения о устаревших функциях.

--trace-deprecation

Выводит трассировки стека для устаревших функций.

--throw-deprecation

Вызывает ошибки для устаревших функций.

--no-warnings

Отключает все предупреждения процесса (включая предупреждения об устаревших функциях).

--trace-warnings

Выводит трассировки стека для предупреждений процесса (включая предупреждения об устаревших функциях).

--redirect-warnings=file

Записывает предупреждения процесса в указанный файл вместо вывода на stderr. Файл будет создан, если он не существует, и будет добавлен к нему, если он существует. Если при попытке записи предупреждения в файл произойдет ошибка, предупреждение будет выведено на stderr вместо этого.

--trace-sync-io

Выводит трассировку стека всякий раз, когда обнаруживается синхронное ввод-вывод после первого цикла события.

--zero-fill-buffers

Автоматически заполняет нулями все вновь выделенные экземпляры Buffer и SlowBuffer.

--preserve-symlinks

Инструктирует загрузчик модулей сохранять символические ссылки при разрешении и кэшировании модулей.

По умолчанию, когда Node.js загружает модуль из пути, символически связанного с другим местоположением на диске, Node.js будет удалять ссылку и использовать фактический на диске «реальный путь» модуля как идентификатор, и как корневой путь для поиска других зависимых модулей. В большинстве случаев это поведение по умолчанию приемлемо. Однако при использовании символически связанных зависимостей peer, как показано в примере ниже, поведение по умолчанию приводит к исключению, если moduleA пытается загрузить moduleB как зависимость peer:

{appDir}
 ├── app
 │   ├── index.js
 │   └── node_modules
 │       ├── moduleA -> {appDir}/moduleA
 │       └── moduleB
 │           ├── index.js
 │           └── package.json
 └── moduleA
     ├── index.js
     └── package.json

Флаг командной строки --preserve-symlinks инструктирует Node.js использовать путь символической ссылки для модулей вместо реального пути, что позволяет находить символически связанные зависимости peer.

Однако следует учитывать, что использование --preserve-symlinks может иметь и другие последствия. В частности, символически связанные нативные модули могут не загружаться, если они связаны более чем из одного места в дереве зависимостей (Node.js увидит их как два отдельных модуля и попытается загрузить модуль несколько раз, что приведет к возникновению исключения).

--track-heap-objects

Отслеживает выделение объектов кучи для создания снимков кучи.

--prof-process

Обрабатывает выходные данные профилировщика v8, сгенерированные с помощью параметра v8 --prof.

--v8-options

Выводит параметры командной строки v8.

Примечание: параметры v8 позволяют разделить слова как дефисами (-) так и нижними подчёркиваниями (_).

Например, --stack-trace-limit эквивалентно --stack_trace_limit.

--tls-cipher-list=list

Указывает альтернативный список шифров TLS по умолчанию. (Требуется, чтобы Node.js был скомпилирован с поддержкой криптографии. (По умолчанию))

--enable-fips

Включает криптографию, совместимую с FIPS, при запуске. (Требуется, чтобы Node.js был скомпилирован с ./configure --openssl-fips)

--force-fips

Принудительно включает криптографию, совместимую с FIPS, при запуске. (Не может быть отключено из кода скрипта.) (Требуются те же условия, что и для --enable-fips)

--openssl-config=file

Загружает файл конфигурации OpenSSL при запуске. Среди прочего, это может быть использовано для включения криптографии, совместимой с FIPS, если Node.js был скомпилирован с ./configure --openssl-fips.

--use-openssl-ca, --use-bundled-ca

Использует хранилище сертификатов CA по умолчанию OpenSSL или использует хранилище сертификатов CA Mozilla, предоставляемое текущей версией Node.js. Хранилище по умолчанию выбирается на этапе компиляции.

Использование хранилища OpenSSL позволяет производить внешние изменения в хранилище. Для большинства дистрибутивов Linux и BSD это хранилище поддерживается разработчиками дистрибутива и системными администраторами. Местоположение хранилища CA OpenSSL зависит от конфигурации библиотеки OpenSSL, но это может быть изменено во время выполнения с помощью переменных среды.

Поставляемое с Node.js хранилище сертификатов CA — это моментальный снимок хранилища сертификатов CA Mozilla, фиксированный на момент выпуска. Оно одинаково на всех поддерживаемых платформах.

См. SSL_CERT_DIR и SSL_CERT_FILE.

--icu-data-dir=file

Указывает путь загрузки данных ICU. (переопределяет NODE_ICU_DATA).

--

Указывает конец параметров node. Передает остальные аргументы скрипту. Если до этого не был указан имя файла скрипта или скрипт eval/print, то следующий аргумент будет использован как имя файла скрипта.

--max-http-header-size=size

Указывает максимальный размер заголовков HTTP в байтах. По умолчанию 8 КБ.

Переменные среды

NODE_DEBUG=module[,…]

',' список ядра модулей, которые должны выводить отладочную информацию.

NODE_PATH=path[:…]

':' список каталогов, добавляемых в начало пути поиска модулей.

Примечание: в Windows это список, разделённый ';' .

NODE_DISABLE_COLORS=1

При установке в 1 цвета не будут использоваться в REPL.

NODE_ICU_DATA=file

Путь к данным ICU (объект Intl). Будет расширять связанные данные при компиляции с поддержкой small-icu.

NODE_NO_WARNINGS=1

При установке в 1, предупреждения процесса будут отключены.

NODE_OPTIONS=options...

options... интерпретируются так, как если бы они были указаны в командной строке до фактического командного запуска (поэтому их можно переопределить). Node завершит выполнение с ошибкой, если используется параметр, который не разрешён в среде, например -p или имя файла скрипта.

Разрешенные параметры node:

• --enable-fips
• --force-fips
• --icu-data-dir
• --debug-brk
• --debug-port
• --debug
• --max-http-header-size
• --no-deprecation
• --no-warnings
• --openssl-config
• --redirect-warnings
• --require, -r
• --throw-deprecation
• --tls-cipher-list
• --trace-deprecation
• --trace-sync-io
• --trace-warnings
• --track-heap-objects
• --use-bundled-ca
• --use-openssl-ca
• --v8-pool-size
• --zero-fill-buffers

Разрешенные параметры V8:

• --abort-on-uncaught-exception
• --max-old-space-size

NODE_REPL_HISTORY=file

Путь к файлу, используемому для хранения истории REPL. По умолчанию путь — ~/.node_repl_history, но он переопределяется этой переменной. Установка значения в пустую строку ('' или ' ') отключает сохранение истории REPL.

NODE_TTY_UNSAFE_ASYNC=1

При установке в 1, запись в stdout и stderr будет выполняться асинхронно и без блокировки при выводе в TTY на платформах, поддерживающих асинхронный ввод-вывод. Установка этого значения аннулирует любые гарантии, что ввод-вывод не будет перемешан или потерян при завершении программы. Использование этого режима не рекомендуется.

NODE_EXTRA_CA_CERTS=file

При установке дополнительные сертификаты корневых центров (например, VeriSign) будут добавлены к известным. Эти сертификаты находятся в файле file. Файл должен содержать один или несколько доверенных сертификатов в формате PEM. Сообщение будет выведено (один раз) с помощью process.emitWarning(), если файл отсутствует или имеет неправильный формат, но другие ошибки будут проигнорированы.

Обратите внимание, что ни известные, ни дополнительные сертификаты не используются, когда свойство ca явно задано для клиента или сервера TLS или HTTPS.

OPENSSL_CONF=file

Загрузка файла конфигурации OpenSSL при запуске. Среди прочего, это может быть использовано для включения криптографии, соответствующей стандарту FIPS, если Node.js был скомпилирован с ./configure --openssl-fips.

Если используется опция командной строки --openssl-config, переменная окружения игнорируется.

SSL_CERT_DIR=dir

Если --use-openssl-ca включено, это переопределяет и задаёт директорию OpenSSL, содержащую доверенные сертификаты.

Примечание: Помните, что если среда дочернего процесса не задана явно, эта переменная окружения будет унаследована всеми дочерними процессами, и если они используют OpenSSL, это может привести к тому, что они будут доверять тем же CA-сертификатам, что и узел.

SSL_CERT_FILE=file

Если --use-openssl-ca включено, это переопределяет и задаёт файл OpenSSL, содержащий доверенные сертификаты.

Примечание: Помните, что если среда дочернего процесса не задана явно, эта переменная окружения будет унаследована всеми дочерними процессами, и если они используют OpenSSL, это может привести к тому, что они будут доверять тем же CA-сертификатам, что и узел.

NODE_REDIRECT_WARNINGS=file

При установке сообщения об ошибках будут записываться в указанный файл, вместо вывода в stderr. Файл будет создан, если он не существует, и будет дополняться, если он существует. Если при попытке записи предупреждения в файл произойдёт ошибка, предупреждение будет выведено в stderr. Это эквивалентно использованию флага командной строки --redirect-warnings=file.