Browse Source

doc: add `added: ` data for cli.md

PR-URL: https://github.com/nodejs/node/pull/6960
Refs: https://github.com/nodejs/node/issues/6578
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
v6.x
Rich Trott 9 years ago
committed by Rod Vagg
parent
commit
bc2efe22f6
  1. 83
      doc/api/cli.md

83
doc/api/cli.md

@ -2,7 +2,7 @@
<!--type=misc-->
Node.js comes with a wide variety of CLI options. These options expose built-in
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`.
@ -24,38 +24,59 @@ _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. The modules which are
predefined in the REPL can also be used in `script`.
### `-p`, `--print "script"`
<!-- YAML
added: v0.6.4
-->
Identical to `-e` but prints the result.
### `-c`, `--check`
<!-- YAML
added: v5.0.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.
@ -64,40 +85,64 @@ 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.
### `--no-warnings`
<!-- YAML
added: v6.0.0
-->
Silence all process warnings (including deprecations).
### `--trace-warnings`
<!-- YAML
added: v6.0.0
-->
Print stack traces for process warnings (including 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: v6.0.0
-->
Automatically zero-fills all newly allocated [Buffer][] and [SlowBuffer][]
instances.
### `--preserve-symlinks`
<!-- YAML
added: v6.3.0
-->
Instructs the module loader to preserve symbolic links when resolving and
caching modules.
@ -135,16 +180,25 @@ see those as two separate modules and would attempt to load the module multiple
times, causing an exception to be thrown).
### `--track-heap-objects`
<!-- YAML
added: v2.4.0
-->
Track heap object allocations for heap snapshots.
### `--prof-process`
<!-- YAML
added: v6.0.0
-->
Process v8 profiler output generated using the v8 option `--prof`.
### `--v8-options`
<!-- YAML
added: v0.1.3
-->
Print v8 command line options.
@ -154,35 +208,53 @@ Note: v8 options allow words to be separated by both dashes (`-`) or underscores
For example, `--stack-trace-limit` is equivalent to `--stack_trace_limit`.
### `--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`
<!-- YAML
added: v6.0.0
-->
Enable FIPS-compliant crypto at startup. (Requires Node.js to be built with
`./configure --openssl-fips`)
### `--force-fips`
<!-- YAML
added: v6.0.0
-->
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.
@ -190,17 +262,26 @@ _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: v5.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

Loading…
Cancel
Save