{ "source": "doc/api/cli.md", "miscs": [ { "textRaw": "Command Line Options", "name": "Command Line Options", "type": "misc", "desc": "

Node.js comes with a variety of CLI options. These options expose built-in\ndebugging, multiple ways to execute scripts, and other helpful runtime options.

\n

To view this documentation as a manual page in your terminal, run man node.

\n", "miscs": [ { "textRaw": "Synopsis", "name": "synopsis", "desc": "

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

\n

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

\n

node --v8-options

\n

Execute without arguments to start the [REPL][].

\n

For more info about node debug, please see the [debugger][] documentation.

\n", "type": "misc", "displayName": "Synopsis" }, { "textRaw": "Options", "name": "options", "modules": [ { "textRaw": "`-v`, `--version`", "name": "`-v`,_`--version`", "meta": { "added": [ "v0.1.3" ] }, "desc": "

Print node's version.

\n", "type": "module", "displayName": "`-v`, `--version`" }, { "textRaw": "`-h`, `--help`", "name": "`-h`,_`--help`", "meta": { "added": [ "v0.1.3" ] }, "desc": "

Print node command line options.\nThe output of this option is less detailed than this document.

\n", "type": "module", "displayName": "`-h`, `--help`" }, { "textRaw": "`-e`, `--eval \"script\"`", "name": "`-e`,_`--eval_\"script\"`", "meta": { "added": [ "v0.5.2" ] }, "desc": "

Evaluate the following argument as JavaScript.

\n", "type": "module", "displayName": "`-e`, `--eval \"script\"`" }, { "textRaw": "`-p`, `--print \"script\"`", "name": "`-p`,_`--print_\"script\"`", "meta": { "added": [ "v0.6.4" ] }, "desc": "

Identical to -e but prints the result.

\n", "type": "module", "displayName": "`-p`, `--print \"script\"`" }, { "textRaw": "`-c`, `--check`", "name": "`-c`,_`--check`", "meta": { "added": [ "v4.2.0" ] }, "desc": "

Syntax check the script without executing.

\n", "type": "module", "displayName": "`-c`, `--check`" }, { "textRaw": "`-i`, `--interactive`", "name": "`-i`,_`--interactive`", "meta": { "added": [ "v0.7.7" ] }, "desc": "

Opens the REPL even if stdin does not appear to be a terminal.

\n", "type": "module", "displayName": "`-i`, `--interactive`" }, { "textRaw": "`-r`, `--require module`", "name": "`-r`,_`--require_module`", "meta": { "added": [ "v1.6.0" ] }, "desc": "

Preload the specified module at startup.

\n

Follows require()'s module resolution\nrules. module may be either a path to a file, or a node module name.

\n", "type": "module", "displayName": "`-r`, `--require module`" }, { "textRaw": "`--no-deprecation`", "name": "`--no-deprecation`", "meta": { "added": [ "v0.8.0" ] }, "desc": "

Silence deprecation warnings.

\n", "type": "module", "displayName": "`--no-deprecation`" }, { "textRaw": "`--trace-deprecation`", "name": "`--trace-deprecation`", "meta": { "added": [ "v0.8.0" ] }, "desc": "

Print stack traces for deprecations.

\n", "type": "module", "displayName": "`--trace-deprecation`" }, { "textRaw": "`--throw-deprecation`", "name": "`--throw-deprecation`", "meta": { "added": [ "v0.11.14" ] }, "desc": "

Throw errors for deprecations.

\n", "type": "module", "displayName": "`--throw-deprecation`" }, { "textRaw": "`--trace-sync-io`", "name": "`--trace-sync-io`", "meta": { "added": [ "v2.1.0" ] }, "desc": "

Prints a stack trace whenever synchronous I/O is detected after the first turn\nof the event loop.

\n", "type": "module", "displayName": "`--trace-sync-io`" }, { "textRaw": "`--zero-fill-buffers`", "name": "`--zero-fill-buffers`", "meta": { "added": [ "v4.5.0" ] }, "desc": "

Automatically zero-fills all newly allocated [Buffer][] and [SlowBuffer][]\ninstances.

\n", "type": "module", "displayName": "`--zero-fill-buffers`" }, { "textRaw": "`--track-heap-objects`", "name": "`--track-heap-objects`", "meta": { "added": [ "v2.4.0" ] }, "desc": "

Track heap object allocations for heap snapshots.

\n", "type": "module", "displayName": "`--track-heap-objects`" }, { "textRaw": "`--prof-process`", "name": "`--prof-process`", "meta": { "added": [ "v4.4.0" ] }, "desc": "

Process v8 profiler output generated using the v8 option --prof.

\n", "type": "module", "displayName": "`--prof-process`" }, { "textRaw": "`--v8-options`", "name": "`--v8-options`", "meta": { "added": [ "v0.1.3" ] }, "desc": "

Print v8 command line options.

\n", "type": "module", "displayName": "`--v8-options`" }, { "textRaw": "`--tls-cipher-list=list`", "name": "`--tls-cipher-list=list`", "meta": { "added": [ "v4.0.0" ] }, "desc": "

Specify an alternative default TLS cipher list. (Requires Node.js to be built\nwith crypto support. (Default))

\n", "type": "module", "displayName": "`--tls-cipher-list=list`" }, { "textRaw": "`--enable-fips`", "name": "`--enable-fips`", "desc": "

Enable FIPS-compliant crypto at startup. (Requires Node.js to be built with\n./configure --openssl-fips)

\n", "type": "module", "displayName": "`--enable-fips`" }, { "textRaw": "`--force-fips`", "name": "`--force-fips`", "desc": "

Force FIPS-compliant crypto on startup. (Cannot be disabled from script code.)\n(Same requirements as --enable-fips)

\n", "type": "module", "displayName": "`--force-fips`" }, { "textRaw": "`--icu-data-dir=file`", "name": "`--icu-data-dir=file`", "meta": { "added": [ "v0.11.15" ] }, "desc": "

Specify ICU data load path. (overrides NODE_ICU_DATA)

\n", "type": "module", "displayName": "`--icu-data-dir=file`" } ], "type": "misc", "displayName": "Options" }, { "textRaw": "Environment Variables", "name": "environment_variables", "modules": [ { "textRaw": "`NODE_DEBUG=module[,…]`", "name": "`node_debug=module[,…]`", "meta": { "added": [ "v0.1.32" ] }, "desc": "

','-separated list of core modules that should print debug information.

\n", "type": "module", "displayName": "`NODE_DEBUG=module[,…]`" }, { "textRaw": "`NODE_PATH=path[:…]`", "name": "`node_path=path[:…]`", "meta": { "added": [ "v0.1.32" ] }, "desc": "

':'-separated list of directories prefixed to the module search path.

\n

Note: on Windows, this is a ';'-separated list instead.

\n", "type": "module", "displayName": "`NODE_PATH=path[:…]`" }, { "textRaw": "`NODE_DISABLE_COLORS=1`", "name": "`node_disable_colors=1`", "meta": { "added": [ "v0.3.0" ] }, "desc": "

When set to 1 colors will not be used in the REPL.

\n", "type": "module", "displayName": "`NODE_DISABLE_COLORS=1`" }, { "textRaw": "`NODE_ICU_DATA=file`", "name": "`node_icu_data=file`", "meta": { "added": [ "v0.11.15" ] }, "desc": "

Data path for ICU (Intl object) data. Will extend linked-in data when compiled\nwith small-icu support.

\n", "type": "module", "displayName": "`NODE_ICU_DATA=file`" }, { "textRaw": "`NODE_REPL_HISTORY=file`", "name": "`node_repl_history=file`", "meta": { "added": [ "v3.0.0" ] }, "desc": "

Path to the file used to store the persistent REPL history. The default path is\n~/.node_repl_history, which is overridden by this variable. Setting the value\nto an empty string ("" or " ") disables persistent REPL history.

\n", "type": "module", "displayName": "`NODE_REPL_HISTORY=file`" } ], "type": "misc", "displayName": "Environment Variables" } ] } ] }