|
|
|
|
# Command Line Options
|
|
|
|
|
|
|
|
|
|
<!--type=misc-->
|
|
|
|
|
|
|
|
|
|
Node.js comes with a variety of CLI options. These options expose built-in
|
|
|
|
|
debugging, multiple ways to execute scripts, and other helpful runtime options.
|
|
|
|
|
|
|
|
|
|
To view this documentation as a manual page in your terminal, run `man node`.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Synopsis
|
|
|
|
|
|
|
|
|
|
`node [options] [v8 options] [script.js | -e "script"] [arguments]`
|
|
|
|
|
|
|
|
|
|
`node debug [script.js | -e "script" | <host>:<port>] …`
|
|
|
|
|
|
|
|
|
|
`node --v8-options`
|
|
|
|
|
|
|
|
|
|
Execute without arguments to start the [REPL][].
|
|
|
|
|
|
|
|
|
|
_For more info about `node debug`, please see the [debugger][] documentation._
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Options
|
|
|
|
|
|
|
|
|
|
### `-v`, `--version`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v0.1.3
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Print node's version.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `-h`, `--help`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v0.1.3
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Print node command line options.
|
|
|
|
|
The output of this option is less detailed than this document.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `-e`, `--eval "script"`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v0.5.2
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Evaluate the following argument as JavaScript.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `-p`, `--print "script"`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v0.6.4
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Identical to `-e` but prints the result.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `-c`, `--check`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v4.2.0
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Syntax check the script without executing.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `-i`, `--interactive`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v0.7.7
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Opens the REPL even if stdin does not appear to be a terminal.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `-r`, `--require module`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v1.6.0
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Preload the specified module at startup.
|
|
|
|
|
|
|
|
|
|
Follows `require()`'s module resolution
|
|
|
|
|
rules. `module` may be either a path to a file, or a node module name.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `--no-deprecation`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v0.8.0
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Silence deprecation warnings.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `--trace-deprecation`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v0.8.0
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Print stack traces for deprecations.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `--throw-deprecation`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v0.11.14
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Throw errors for deprecations.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `--trace-sync-io`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v2.1.0
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Prints a stack trace whenever synchronous I/O is detected after the first turn
|
|
|
|
|
of the event loop.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `--zero-fill-buffers`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v4.5.0
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Automatically zero-fills all newly allocated [Buffer][] and [SlowBuffer][]
|
|
|
|
|
instances.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `--track-heap-objects`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v2.4.0
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Track heap object allocations for heap snapshots.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `--prof-process`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v4.4.0
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Process v8 profiler output generated using the v8 option `--prof`.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `--v8-options`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v0.1.3
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Print v8 command line options.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `--tls-cipher-list=list`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v4.0.0
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Specify an alternative default TLS cipher list. (Requires Node.js to be built
|
|
|
|
|
with crypto support. (Default))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `--enable-fips`
|
|
|
|
|
|
|
|
|
|
Enable FIPS-compliant crypto at startup. (Requires Node.js to be built with
|
|
|
|
|
`./configure --openssl-fips`)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `--force-fips`
|
|
|
|
|
|
|
|
|
|
Force FIPS-compliant crypto on startup. (Cannot be disabled from script code.)
|
|
|
|
|
(Same requirements as `--enable-fips`)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `--icu-data-dir=file`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v0.11.15
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Specify ICU data load path. (overrides `NODE_ICU_DATA`)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Environment Variables
|
|
|
|
|
|
|
|
|
|
### `NODE_DEBUG=module[,…]`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v0.1.32
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
`','`-separated list of core modules that should print debug information.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `NODE_PATH=path[:…]`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v0.1.32
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
`':'`-separated list of directories prefixed to the module search path.
|
|
|
|
|
|
|
|
|
|
_Note: on Windows, this is a `';'`-separated list instead._
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `NODE_DISABLE_COLORS=1`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v0.3.0
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
When set to `1` colors will not be used in the REPL.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `NODE_ICU_DATA=file`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v0.11.15
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Data path for ICU (Intl object) data. Will extend linked-in data when compiled
|
|
|
|
|
with small-icu support.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `NODE_REPL_HISTORY=file`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: v3.0.0
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
Path to the file used to store the persistent REPL history. The default path is
|
|
|
|
|
`~/.node_repl_history`, which is overridden by this variable. Setting the value
|
|
|
|
|
to an empty string (`""` or `" "`) disables persistent REPL history.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### `NODE_EXTRA_CA_CERTS=file`
|
|
|
|
|
<!-- YAML
|
|
|
|
|
added: XXX
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
When set, the well known "root" CAs (like VeriSign) will be extended with the
|
|
|
|
|
extra certificates in `file`. The file should consist of one or more trusted
|
|
|
|
|
certificates in PEM format. A message will be printed to stderr (once)
|
|
|
|
|
if the file is missing or
|
|
|
|
|
misformatted, but any errors are otherwise ignored.
|
|
|
|
|
|
|
|
|
|
Note that neither the well known nor extra certificates are used when the `ca`
|
|
|
|
|
options property is explicitly specified for a TLS or HTTPS client or server.
|
|
|
|
|
|
|
|
|
|
[emit_warning]: process.html#process_process_emitwarning_warning_name_ctor
|
|
|
|
|
[Buffer]: buffer.html#buffer_buffer
|
|
|
|
|
[debugger]: debugger.html
|
|
|
|
|
[REPL]: repl.html
|
|
|
|
|
[SlowBuffer]: buffer.html#buffer_class_slowbuffer
|
