2020-06-14 23:49:34 +02:00
|
|
|
# Command line options
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2017-01-23 04:16:21 +01:00
|
|
|
<!--introduced_in=v5.9.1-->
|
2016-03-18 18:26:41 +01:00
|
|
|
<!--type=misc-->
|
|
|
|
|
2016-05-25 02:04:39 +02:00
|
|
|
Node.js comes with a variety of CLI options. These options expose built-in
|
2016-03-18 18:26:41 +01:00
|
|
|
debugging, multiple ways to execute scripts, and other helpful runtime options.
|
|
|
|
|
2017-04-26 19:16:12 +02:00
|
|
|
To view this documentation as a manual page in a terminal, run `man node`.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
|
|
|
## Synopsis
|
|
|
|
|
2017-11-17 06:41:14 +01:00
|
|
|
`node [options] [V8 options] [script.js | -e "script" | -] [--] [arguments]`
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-09-09 16:57:37 +02:00
|
|
|
`node inspect [script.js | -e "script" | <host>:<port>] …`
|
2016-03-18 18:26:41 +01:00
|
|
|
|
|
|
|
`node --v8-options`
|
|
|
|
|
|
|
|
Execute without arguments to start the [REPL][].
|
|
|
|
|
2018-09-09 16:57:37 +02:00
|
|
|
_For more info about `node inspect`, please see the [debugger][] documentation._
|
2016-03-18 18:26:41 +01:00
|
|
|
|
|
|
|
## Options
|
2018-09-22 14:34:00 +02:00
|
|
|
<!-- YAML
|
|
|
|
changes:
|
2018-10-07 14:09:45 +02:00
|
|
|
- version: v10.12.0
|
2018-09-22 14:34:00 +02:00
|
|
|
pr-url: https://github.com/nodejs/node/pull/23020
|
|
|
|
description: Underscores instead of dashes are now allowed for
|
|
|
|
Node.js options as well, in addition to V8 options.
|
|
|
|
-->
|
|
|
|
|
|
|
|
All options, including V8 options, allow words to be separated by both
|
|
|
|
dashes (`-`) or underscores (`_`).
|
|
|
|
|
|
|
|
For example, `--pending-deprecation` is equivalent to `--pending_deprecation`.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `-`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v8.0.0
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2019-10-24 06:28:42 +02:00
|
|
|
Alias for stdin. Analogous to the use of `-` in other command line utilities,
|
2018-04-08 08:33:19 +02:00
|
|
|
meaning that the script will be read from stdin, and the rest of the options
|
|
|
|
are passed to that script.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v6.11.0
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Indicate the end of node options. Pass the rest of the arguments to the script.
|
|
|
|
If no script filename or eval/print script is supplied prior to this, then
|
|
|
|
the next argument will be used as a script filename.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--abort-on-uncaught-exception`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2020-01-14 22:12:14 +01:00
|
|
|
added: v0.10.8
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Aborting instead of exiting causes a core file to be generated for post-mortem
|
|
|
|
analysis using a debugger (such as `lldb`, `gdb`, and `mdb`).
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
If this flag is passed, the behavior can still be set to not abort through
|
|
|
|
[`process.setUncaughtExceptionCaptureCallback()`][] (and through usage of the
|
|
|
|
`domain` module that uses it).
|
2017-09-23 11:37:34 +02:00
|
|
|
|
2018-05-14 13:09:27 +02:00
|
|
|
### `--completion-bash`
|
|
|
|
<!-- YAML
|
2018-10-07 14:09:45 +02:00
|
|
|
added: v10.12.0
|
2018-05-14 13:09:27 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
Print source-able bash completion script for Node.js.
|
2019-08-29 15:28:03 +02:00
|
|
|
|
2018-05-14 13:09:27 +02:00
|
|
|
```console
|
|
|
|
$ node --completion-bash > node_bash_completion
|
|
|
|
$ source node_bash_completion
|
|
|
|
```
|
|
|
|
|
2019-03-23 00:39:52 +01:00
|
|
|
### `--cpu-prof`
|
|
|
|
<!-- YAML
|
2019-03-22 14:19:46 +01:00
|
|
|
added: v12.0.0
|
2019-03-23 00:39:52 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
> Stability: 1 - Experimental
|
|
|
|
|
|
|
|
Starts the V8 CPU profiler on start up, and writes the CPU profile to disk
|
2019-04-19 11:15:04 +02:00
|
|
|
before exit.
|
|
|
|
|
|
|
|
If `--cpu-prof-dir` is not specified, the generated profile will be placed
|
|
|
|
in the current working directory.
|
|
|
|
|
|
|
|
If `--cpu-prof-name` is not specified, the generated profile will be
|
|
|
|
named `CPU.${yyyymmdd}.${hhmmss}.${pid}.${tid}.${seq}.cpuprofile`.
|
2019-03-23 00:39:52 +01:00
|
|
|
|
|
|
|
```console
|
|
|
|
$ node --cpu-prof index.js
|
|
|
|
$ ls *.cpuprofile
|
|
|
|
CPU.20190409.202950.15293.0.0.cpuprofile
|
|
|
|
```
|
|
|
|
|
2019-04-19 11:15:04 +02:00
|
|
|
### `--cpu-prof-dir`
|
2019-03-23 00:39:52 +01:00
|
|
|
<!-- YAML
|
2019-03-22 14:19:46 +01:00
|
|
|
added: v12.0.0
|
2019-03-23 00:39:52 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
> Stability: 1 - Experimental
|
|
|
|
|
2019-04-19 11:15:04 +02:00
|
|
|
Specify the directory where the CPU profiles generated by `--cpu-prof` will
|
|
|
|
be placed.
|
2019-03-23 00:39:52 +01:00
|
|
|
|
2019-05-02 15:10:10 +02:00
|
|
|
### `--cpu-prof-interval`
|
|
|
|
<!-- YAML
|
2019-05-06 14:40:25 +02:00
|
|
|
added: v12.2.0
|
2019-05-02 15:10:10 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
> Stability: 1 - Experimental
|
|
|
|
|
|
|
|
Specify the sampling interval in microseconds for the CPU profiles generated
|
|
|
|
by `--cpu-prof`. The default is 1000 microseconds.
|
|
|
|
|
2019-04-19 11:15:04 +02:00
|
|
|
### `--cpu-prof-name`
|
|
|
|
<!-- YAML
|
2019-03-22 14:19:46 +01:00
|
|
|
added: v12.0.0
|
2019-04-19 11:15:04 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
> Stability: 1 - Experimental
|
|
|
|
|
|
|
|
Specify the file name of the CPU profile generated by `--cpu-prof`.
|
2019-03-23 00:39:52 +01:00
|
|
|
|
2020-03-15 01:54:15 +01:00
|
|
|
### `--disable-proto=mode`
|
2020-05-01 14:43:14 +02:00
|
|
|
<!-- YAML
|
|
|
|
added:
|
|
|
|
- v13.12.0
|
|
|
|
- v12.17.0
|
2020-03-15 01:54:15 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
Disable the `Object.prototype.__proto__` property. If `mode` is `delete`, the
|
|
|
|
property will be removed entirely. If `mode` is `throw`, accesses to the
|
|
|
|
property will throw an exception with the code `ERR_PROTO_ACCESS`.
|
|
|
|
|
2019-10-23 20:06:57 +02:00
|
|
|
### `--disallow-code-generation-from-strings`
|
|
|
|
<!-- YAML
|
|
|
|
added: v9.8.0
|
|
|
|
-->
|
|
|
|
|
|
|
|
Make built-in language features like `eval` and `new Function` that generate
|
|
|
|
code from strings throw an exception instead. This does not affect the Node.js
|
|
|
|
`vm` module.
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--enable-fips`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v6.0.0
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2019-04-03 09:02:47 +02:00
|
|
|
Enable FIPS-compliant crypto at startup. (Requires Node.js to be built with
|
|
|
|
`./configure --openssl-fips`.)
|
|
|
|
|
2019-09-29 23:15:39 +02:00
|
|
|
### `--enable-source-maps`
|
|
|
|
<!-- YAML
|
2019-10-10 14:31:33 +02:00
|
|
|
added: v12.12.0
|
2019-09-29 23:15:39 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
> Stability: 1 - Experimental
|
|
|
|
|
2020-06-14 23:49:34 +02:00
|
|
|
Enable experimental Source Map v3 support for stack traces.
|
2019-09-29 23:15:39 +02:00
|
|
|
|
2019-10-21 07:12:38 +02:00
|
|
|
Currently, overriding `Error.prepareStackTrace` is ignored when the
|
|
|
|
`--enable-source-maps` flag is set.
|
|
|
|
|
2020-05-23 03:11:14 +02:00
|
|
|
### `--experimental-abortcontroller`
|
|
|
|
<!-- YAML
|
|
|
|
added: REPLACEME
|
2020-06-04 20:45:42 +02:00
|
|
|
changes:
|
|
|
|
- version: REPLACEME
|
|
|
|
pr-url: https://github.com/nodejs/node/pull/33527
|
|
|
|
description: --experimental-abortcontroller is no longer required.
|
2020-05-23 03:11:14 +02:00
|
|
|
-->
|
|
|
|
|
2020-06-04 20:45:42 +02:00
|
|
|
Experimental `AbortController` and `AbortSignal` support is enabled by default.
|
|
|
|
Use of this command line flag is no longer required.
|
2020-05-23 03:11:14 +02:00
|
|
|
|
2019-12-19 22:25:52 +01:00
|
|
|
### `--experimental-import-meta-resolve`
|
|
|
|
<!-- YAML
|
2020-04-24 18:43:06 +02:00
|
|
|
added:
|
|
|
|
- v13.9.0
|
|
|
|
- v12.16.2
|
2019-12-19 22:25:52 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
Enable experimental `import.meta.resolve()` support.
|
|
|
|
|
2019-09-28 21:01:23 +02:00
|
|
|
### `--experimental-json-modules`
|
|
|
|
<!-- YAML
|
|
|
|
added: v12.9.0
|
|
|
|
-->
|
|
|
|
|
|
|
|
Enable experimental JSON support for the ES Module loader.
|
|
|
|
|
2020-03-05 00:34:28 +01:00
|
|
|
### `--experimental-loader=module`
|
|
|
|
<!-- YAML
|
|
|
|
added: v9.0.0
|
|
|
|
-->
|
|
|
|
|
|
|
|
Specify the `module` of a custom [experimental ECMAScript Module loader][].
|
|
|
|
`module` may be either a path to a file, or an ECMAScript Module name.
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--experimental-modules`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v8.5.0
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2019-12-17 06:58:30 +01:00
|
|
|
Enable latest experimental modules features (deprecated).
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-09-13 21:27:12 +02:00
|
|
|
### `--experimental-policy`
|
|
|
|
<!-- YAML
|
2019-01-25 19:02:00 +01:00
|
|
|
added: v11.8.0
|
2018-09-13 21:27:12 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
Use the specified file as a security policy.
|
|
|
|
|
2018-04-18 17:50:35 +02:00
|
|
|
### `--experimental-repl-await`
|
|
|
|
<!-- YAML
|
2018-03-02 18:53:46 +01:00
|
|
|
added: v10.0.0
|
2018-04-18 17:50:35 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
Enable experimental top-level `await` keyword support in REPL.
|
|
|
|
|
2019-11-27 07:54:23 +01:00
|
|
|
### `--experimental-specifier-resolution=mode`
|
|
|
|
<!-- YAML
|
2020-04-24 18:43:06 +02:00
|
|
|
added:
|
|
|
|
- v13.4.0
|
|
|
|
- v12.16.0
|
2019-11-27 07:54:23 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
Sets the resolution algorithm for resolving ES module specifiers. Valid options
|
|
|
|
are `explicit` and `node`.
|
|
|
|
|
|
|
|
The default is `explicit`, which requires providing the full path to a
|
|
|
|
module. The `node` mode will enable support for optional file extensions and
|
|
|
|
the ability to import a directory that has an index file.
|
|
|
|
|
|
|
|
Please see [customizing ESM specifier resolution][] for example usage.
|
|
|
|
|
2020-05-20 01:01:30 +02:00
|
|
|
### `--experimental-top-level-await`
|
|
|
|
<!-- YAML
|
|
|
|
added: v14.3.0
|
|
|
|
-->
|
|
|
|
|
|
|
|
Enable experimental top-level `await` keyword support, available only in ES
|
|
|
|
module scripts.
|
|
|
|
|
|
|
|
(See also `--experimental-repl-await`.)
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--experimental-vm-modules`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v9.6.0
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Enable experimental ES Module support in the `vm` module.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2019-12-15 17:30:45 +01:00
|
|
|
### `--experimental-wasi-unstable-preview1`
|
2019-09-04 23:56:51 +02:00
|
|
|
<!-- YAML
|
2020-04-24 18:43:06 +02:00
|
|
|
added:
|
|
|
|
- v13.3.0
|
|
|
|
- v12.16.0
|
2019-12-15 17:30:45 +01:00
|
|
|
changes:
|
2020-01-07 08:33:44 +01:00
|
|
|
- version: v13.6.0
|
2019-12-15 17:30:45 +01:00
|
|
|
pr-url: https://github.com/nodejs/node/pull/30980
|
|
|
|
description: changed from `--experimental-wasi-unstable-preview0` to
|
|
|
|
`--experimental-wasi-unstable-preview1`
|
2019-09-04 23:56:51 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
Enable experimental WebAssembly System Interface (WASI) support.
|
|
|
|
|
2019-05-29 14:51:32 +02:00
|
|
|
### `--experimental-wasm-modules`
|
|
|
|
<!-- YAML
|
|
|
|
added: v12.3.0
|
|
|
|
-->
|
|
|
|
|
2020-06-10 08:16:16 +02:00
|
|
|
### `--force-context-aware`
|
|
|
|
<!-- YAML
|
|
|
|
added: v12.12.0
|
|
|
|
-->
|
|
|
|
|
|
|
|
Disable loading native addons that are not [context-aware][].
|
|
|
|
|
2019-05-29 14:51:32 +02:00
|
|
|
Enable experimental WebAssembly module support.
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--force-fips`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v6.0.0
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Force FIPS-compliant crypto on startup. (Cannot be disabled from script code.)
|
2018-04-29 13:16:44 +02:00
|
|
|
(Same requirements as `--enable-fips`.)
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2019-01-24 19:56:33 +01:00
|
|
|
### `--frozen-intrinsics`
|
|
|
|
<!-- YAML
|
2019-03-13 22:59:36 +01:00
|
|
|
added: v11.12.0
|
2019-01-24 19:56:33 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
> Stability: 1 - Experimental
|
|
|
|
|
|
|
|
Enable experimental frozen intrinsics like `Array` and `Object`.
|
|
|
|
|
|
|
|
Support is currently only provided for the root context and no guarantees are
|
|
|
|
currently provided that `global.Array` is indeed the default intrinsic
|
2019-06-16 23:00:17 +02:00
|
|
|
reference. Code may break under this flag.
|
2019-01-24 19:56:33 +01:00
|
|
|
|
2019-08-02 16:06:34 +02:00
|
|
|
`--require` runs prior to freezing intrinsics in order to allow polyfills to
|
|
|
|
be added.
|
|
|
|
|
2019-04-08 16:20:26 +02:00
|
|
|
### `--heapsnapshot-signal=signal`
|
|
|
|
<!-- YAML
|
2019-03-22 14:19:46 +01:00
|
|
|
added: v12.0.0
|
2019-04-08 16:20:26 +02:00
|
|
|
-->
|
|
|
|
|
2019-07-18 21:36:12 +02:00
|
|
|
Enables a signal handler that causes the Node.js process to write a heap dump
|
2019-10-19 15:16:40 +02:00
|
|
|
when the specified signal is received. `signal` must be a valid signal name.
|
|
|
|
Disabled by default.
|
2019-07-18 21:36:12 +02:00
|
|
|
|
|
|
|
```console
|
|
|
|
$ node --heapsnapshot-signal=SIGUSR2 index.js &
|
|
|
|
$ ps aux
|
|
|
|
USER PID %CPU %MEM VSZ RSS TTY STAT START TIME COMMAND
|
|
|
|
node 1 5.5 6.1 787252 247004 ? Ssl 16:43 0:02 node --heapsnapshot-signal=SIGUSR2 index.js
|
|
|
|
$ kill -USR2 1
|
|
|
|
$ ls
|
|
|
|
Heap.20190718.133405.15554.0.001.heapsnapshot
|
|
|
|
```
|
|
|
|
|
2019-04-23 05:47:28 +02:00
|
|
|
### `--heap-prof`
|
|
|
|
<!-- YAML
|
2019-06-03 14:10:53 +02:00
|
|
|
added: v12.4.0
|
2019-04-23 05:47:28 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
> Stability: 1 - Experimental
|
|
|
|
|
|
|
|
Starts the V8 heap profiler on start up, and writes the heap profile to disk
|
|
|
|
before exit.
|
|
|
|
|
|
|
|
If `--heap-prof-dir` is not specified, the generated profile will be placed
|
|
|
|
in the current working directory.
|
|
|
|
|
|
|
|
If `--heap-prof-name` is not specified, the generated profile will be
|
|
|
|
named `Heap.${yyyymmdd}.${hhmmss}.${pid}.${tid}.${seq}.heapprofile`.
|
|
|
|
|
|
|
|
```console
|
|
|
|
$ node --heap-prof index.js
|
|
|
|
$ ls *.heapprofile
|
|
|
|
Heap.20190409.202950.15293.0.001.heapprofile
|
|
|
|
```
|
|
|
|
|
|
|
|
### `--heap-prof-dir`
|
|
|
|
<!-- YAML
|
2019-06-03 14:10:53 +02:00
|
|
|
added: v12.4.0
|
2019-04-23 05:47:28 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
> Stability: 1 - Experimental
|
|
|
|
|
|
|
|
Specify the directory where the heap profiles generated by `--heap-prof` will
|
|
|
|
be placed.
|
|
|
|
|
|
|
|
### `--heap-prof-interval`
|
|
|
|
<!-- YAML
|
2019-06-03 14:10:53 +02:00
|
|
|
added: v12.4.0
|
2019-04-23 05:47:28 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
> Stability: 1 - Experimental
|
|
|
|
|
|
|
|
Specify the average sampling interval in bytes for the heap profiles generated
|
|
|
|
by `--heap-prof`. The default is 512 * 1024 bytes.
|
|
|
|
|
|
|
|
### `--heap-prof-name`
|
|
|
|
<!-- YAML
|
2019-06-03 14:10:53 +02:00
|
|
|
added: v12.4.0
|
2019-04-23 05:47:28 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
> Stability: 1 - Experimental
|
|
|
|
|
|
|
|
Specify the file name of the heap profile generated by `--heap-prof`.
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--icu-data-dir=file`
|
2017-03-16 03:34:51 +01:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v0.11.15
|
2017-03-16 03:34:51 +01:00
|
|
|
-->
|
|
|
|
|
2018-04-29 13:16:44 +02:00
|
|
|
Specify ICU data load path. (Overrides `NODE_ICU_DATA`.)
|
2017-03-16 03:34:51 +01:00
|
|
|
|
2019-04-15 19:29:56 +02:00
|
|
|
### `--input-type=type`
|
|
|
|
<!-- YAML
|
2019-03-22 14:19:46 +01:00
|
|
|
added: v12.0.0
|
2019-04-15 19:29:56 +02:00
|
|
|
-->
|
|
|
|
|
2019-10-11 23:57:13 +02:00
|
|
|
This configures Node.js to interpret string input as CommonJS or as an ES
|
|
|
|
module. String input is input via `--eval`, `--print`, or `STDIN`.
|
2019-04-15 19:29:56 +02:00
|
|
|
|
|
|
|
Valid values are `"commonjs"` and `"module"`. The default is `"commonjs"`.
|
|
|
|
|
2017-03-28 17:54:30 +02:00
|
|
|
### `--inspect-brk[=[host:]port]`
|
2017-03-16 03:34:51 +01:00
|
|
|
<!-- YAML
|
|
|
|
added: v7.6.0
|
|
|
|
-->
|
|
|
|
|
2018-04-29 19:46:41 +02:00
|
|
|
Activate inspector on `host:port` and break at start of user script.
|
|
|
|
Default `host:port` is `127.0.0.1:9229`.
|
2017-04-22 05:34:54 +02:00
|
|
|
|
|
|
|
### `--inspect-port=[host:]port`
|
|
|
|
<!-- YAML
|
|
|
|
added: v7.6.0
|
|
|
|
-->
|
|
|
|
|
2018-04-29 19:46:41 +02:00
|
|
|
Set the `host:port` to be used when the inspector is activated.
|
2017-04-22 05:34:54 +02:00
|
|
|
Useful when activating the inspector by sending the `SIGUSR1` signal.
|
|
|
|
|
2018-04-29 19:46:41 +02:00
|
|
|
Default host is `127.0.0.1`.
|
2017-03-16 03:34:51 +01:00
|
|
|
|
2018-10-13 18:40:44 +02:00
|
|
|
See the [security warning](#inspector_security) below regarding the `host`
|
|
|
|
parameter usage.
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--inspect[=[host:]port]`
|
|
|
|
<!-- YAML
|
|
|
|
added: v6.3.0
|
|
|
|
-->
|
|
|
|
|
2018-04-29 19:46:41 +02:00
|
|
|
Activate inspector on `host:port`. Default is `127.0.0.1:9229`.
|
2018-04-08 08:33:19 +02:00
|
|
|
|
|
|
|
V8 inspector integration allows tools such as Chrome DevTools and IDEs to debug
|
|
|
|
and profile Node.js instances. The tools attach to Node.js instances via a
|
2018-04-17 19:04:03 +02:00
|
|
|
tcp port and communicate using the [Chrome DevTools Protocol][].
|
2018-04-08 08:33:19 +02:00
|
|
|
|
2018-10-13 18:40:44 +02:00
|
|
|
<a id="inspector_security"></a>
|
|
|
|
#### Warning: binding inspector to a public IP:port combination is insecure
|
|
|
|
|
|
|
|
Binding the inspector to a public IP (including `0.0.0.0`) with an open port is
|
|
|
|
insecure, as it allows external hosts to connect to the inspector and perform
|
|
|
|
a [remote code execution][] attack.
|
|
|
|
|
2019-01-29 01:07:31 +01:00
|
|
|
If specifying a host, make sure that either:
|
|
|
|
|
|
|
|
* The host is not accessible from public networks.
|
|
|
|
* A firewall disallows unwanted connections on the port.
|
2018-10-13 18:40:44 +02:00
|
|
|
|
|
|
|
**More specifically, `--inspect=0.0.0.0` is insecure if the port (`9229` by
|
|
|
|
default) is not firewall-protected.**
|
|
|
|
|
|
|
|
See the [debugging security implications][] section for more information.
|
|
|
|
|
2019-05-17 00:33:09 +02:00
|
|
|
### `--inspect-publish-uid=stderr,http`
|
|
|
|
|
|
|
|
Specify ways of the inspector web socket url exposure.
|
|
|
|
|
|
|
|
By default inspector websocket url is available in stderr and under `/json/list`
|
|
|
|
endpoint on `http://host:port/json/list`.
|
|
|
|
|
2019-11-20 20:48:58 +01:00
|
|
|
### `--insecure-http-parser`
|
|
|
|
<!-- YAML
|
2020-04-24 18:43:06 +02:00
|
|
|
added:
|
|
|
|
- v13.4.0
|
|
|
|
- v12.15.0
|
|
|
|
- v10.19.0
|
2019-11-20 20:48:58 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
Use an insecure HTTP parser that accepts invalid HTTP headers. This may allow
|
|
|
|
interoperability with non-conformant HTTP implementations. It may also allow
|
|
|
|
request smuggling and other HTTP attacks that rely on invalid headers being
|
|
|
|
accepted. Avoid using this option.
|
|
|
|
|
2020-03-05 00:34:28 +01:00
|
|
|
### `--jitless`
|
|
|
|
<!-- YAML
|
|
|
|
added: v12.0.0
|
|
|
|
-->
|
|
|
|
|
|
|
|
Disable [runtime allocation of executable memory][jitless]. This may be
|
|
|
|
required on some platforms for security reasons. It can also reduce attack
|
|
|
|
surface on other platforms, but the performance impact may be severe.
|
|
|
|
|
|
|
|
This flag is inherited from V8 and is subject to change upstream. It may
|
|
|
|
disappear in a non-semver-major release.
|
|
|
|
|
2018-12-03 18:27:46 +01:00
|
|
|
### `--max-http-header-size=size`
|
|
|
|
<!-- YAML
|
2020-04-24 18:43:06 +02:00
|
|
|
added:
|
|
|
|
- v11.6.0
|
|
|
|
- v10.15.0
|
2020-03-27 16:34:24 +01:00
|
|
|
changes:
|
2020-04-13 14:33:10 +02:00
|
|
|
- version: v13.13.0
|
2020-03-27 16:34:24 +01:00
|
|
|
pr-url: https://github.com/nodejs/node/pull/32520
|
|
|
|
description: Change maximum default size of HTTP headers from 8KB to 16KB.
|
2018-12-03 18:27:46 +01:00
|
|
|
-->
|
|
|
|
|
2020-03-27 16:34:24 +01:00
|
|
|
Specify the maximum size, in bytes, of HTTP headers. Defaults to 16KB.
|
2018-12-03 18:27:46 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--napi-modules`
|
|
|
|
<!-- YAML
|
|
|
|
added: v7.10.0
|
|
|
|
-->
|
|
|
|
|
2018-04-25 19:49:48 +02:00
|
|
|
This option is a no-op. It is kept for compatibility.
|
2018-04-08 08:33:19 +02:00
|
|
|
|
2016-03-18 18:26:41 +01:00
|
|
|
### `--no-deprecation`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
|
|
|
added: v0.8.0
|
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
|
|
|
Silence deprecation warnings.
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--no-force-async-hooks-checks`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v9.0.0
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Disables runtime checks for `async_hooks`. These will still be enabled
|
|
|
|
dynamically when `async_hooks` is enabled.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--no-warnings`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v6.0.0
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Silence all process warnings (including deprecations).
|
|
|
|
|
|
|
|
### `--openssl-config=file`
|
|
|
|
<!-- YAML
|
|
|
|
added: v6.9.0
|
|
|
|
-->
|
|
|
|
|
|
|
|
Load an OpenSSL configuration file on startup. Among other uses, this can be
|
|
|
|
used to enable FIPS-compliant crypto if Node.js is built with
|
|
|
|
`./configure --openssl-fips`.
|
|
|
|
|
2017-03-11 21:18:53 +01:00
|
|
|
### `--pending-deprecation`
|
|
|
|
<!-- YAML
|
2017-03-16 04:26:14 +01:00
|
|
|
added: v8.0.0
|
2017-03-11 21:18:53 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
Emit pending deprecation warnings.
|
|
|
|
|
2018-02-06 06:55:16 +01:00
|
|
|
Pending deprecations are generally identical to a runtime deprecation with the
|
|
|
|
notable exception that they are turned *off* by default and will not be emitted
|
|
|
|
unless either the `--pending-deprecation` command line flag, or the
|
2017-03-11 21:18:53 +01:00
|
|
|
`NODE_PENDING_DEPRECATION=1` environment variable, is set. Pending deprecations
|
|
|
|
are used to provide a kind of selective "early warning" mechanism that
|
|
|
|
developers may leverage to detect deprecated API usage.
|
|
|
|
|
2019-06-05 20:33:07 +02:00
|
|
|
### `--policy-integrity=sri`
|
|
|
|
<!-- YAML
|
2019-07-23 10:29:14 +02:00
|
|
|
added: v12.7.0
|
2019-06-05 20:33:07 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
> Stability: 1 - Experimental
|
|
|
|
|
|
|
|
Instructs Node.js to error prior to running any code if the policy does not have
|
|
|
|
the specified integrity. It expects a [Subresource Integrity][] string as a
|
|
|
|
parameter.
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--preserve-symlinks`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v6.3.0
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-01-20 20:38:35 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Instructs the module loader to preserve symbolic links when resolving and
|
|
|
|
caching modules.
|
2016-01-20 20:38:35 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
By default, when Node.js loads a module from a path that is symbolically linked
|
|
|
|
to a different on-disk location, Node.js will dereference the link and use the
|
|
|
|
actual on-disk "real path" of the module as both an identifier and as a root
|
|
|
|
path to locate other dependency modules. In most cases, this default behavior
|
|
|
|
is acceptable. However, when using symbolically linked peer dependencies, as
|
|
|
|
illustrated in the example below, the default behavior causes an exception to
|
|
|
|
be thrown if `moduleA` attempts to require `moduleB` as a peer dependency:
|
2017-06-26 20:00:34 +02:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
```text
|
|
|
|
{appDir}
|
|
|
|
├── app
|
|
|
|
│ ├── index.js
|
|
|
|
│ └── node_modules
|
|
|
|
│ ├── moduleA -> {appDir}/moduleA
|
|
|
|
│ └── moduleB
|
|
|
|
│ ├── index.js
|
|
|
|
│ └── package.json
|
|
|
|
└── moduleA
|
|
|
|
├── index.js
|
|
|
|
└── package.json
|
|
|
|
```
|
2017-03-20 22:55:26 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
The `--preserve-symlinks` command line flag instructs Node.js to use the
|
|
|
|
symlink path for modules as opposed to the real path, allowing symbolically
|
|
|
|
linked peer dependencies to be found.
|
2017-11-20 19:57:20 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Note, however, that using `--preserve-symlinks` can have other side effects.
|
|
|
|
Specifically, symbolically linked *native* modules can fail to load if those
|
|
|
|
are linked from more than one location in the dependency tree (Node.js would
|
|
|
|
see those as two separate modules and would attempt to load the module multiple
|
|
|
|
times, causing an exception to be thrown).
|
|
|
|
|
2018-04-10 09:40:56 +02:00
|
|
|
The `--preserve-symlinks` flag does not apply to the main module, which allows
|
2018-11-24 09:42:09 +01:00
|
|
|
`node --preserve-symlinks node_module/.bin/<foo>` to work. To apply the same
|
2018-04-10 09:40:56 +02:00
|
|
|
behavior for the main module, also use `--preserve-symlinks-main`.
|
|
|
|
|
|
|
|
### `--preserve-symlinks-main`
|
|
|
|
<!-- YAML
|
2018-05-14 20:01:36 +02:00
|
|
|
added: v10.2.0
|
2018-04-10 09:40:56 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
Instructs the module loader to preserve symbolic links when resolving and
|
|
|
|
caching the main module (`require.main`).
|
|
|
|
|
|
|
|
This flag exists so that the main module can be opted-in to the same behavior
|
|
|
|
that `--preserve-symlinks` gives to all other imports; they are separate flags,
|
|
|
|
however, for backward compatibility with older Node.js versions.
|
|
|
|
|
2019-06-20 22:07:01 +02:00
|
|
|
`--preserve-symlinks-main` does not imply `--preserve-symlinks`; it
|
2018-04-10 09:40:56 +02:00
|
|
|
is expected that `--preserve-symlinks-main` will be used in addition to
|
|
|
|
`--preserve-symlinks` when it is not desirable to follow symlinks before
|
|
|
|
resolving relative paths.
|
|
|
|
|
|
|
|
See `--preserve-symlinks` for more information.
|
|
|
|
|
2018-05-20 12:05:08 +02:00
|
|
|
### `--prof`
|
|
|
|
<!-- YAML
|
|
|
|
added: v2.0.0
|
|
|
|
-->
|
|
|
|
|
|
|
|
Generate V8 profiler output.
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--prof-process`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v5.2.0
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-01-20 20:38:35 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Process V8 profiler output generated using the V8 option `--prof`.
|
|
|
|
|
2016-12-04 19:38:35 +01:00
|
|
|
### `--redirect-warnings=file`
|
|
|
|
<!-- YAML
|
2017-03-16 04:26:14 +01:00
|
|
|
added: v8.0.0
|
2016-12-04 19:38:35 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
Write process warnings to the given file instead of printing to stderr. The
|
|
|
|
file will be created if it does not exist, and will be appended to if it does.
|
|
|
|
If an error occurs while attempting to write the warning to the file, the
|
|
|
|
warning will be written to stderr instead.
|
|
|
|
|
2020-03-13 17:45:39 +01:00
|
|
|
### `--report-compact`
|
|
|
|
<!-- YAML
|
2020-05-01 14:43:14 +02:00
|
|
|
added:
|
|
|
|
- v13.12.0
|
|
|
|
- v12.17.0
|
2020-03-13 17:45:39 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
Write reports in a compact format, single-line JSON, more easily consumable
|
|
|
|
by log processing systems than the default multi-line format designed for
|
|
|
|
human consumption.
|
|
|
|
|
2020-06-04 13:07:01 +02:00
|
|
|
### `--report-dir=directory`, `report-directory=directory`
|
2019-04-19 17:12:28 +02:00
|
|
|
<!-- YAML
|
|
|
|
added: v11.8.0
|
|
|
|
changes:
|
2020-05-01 14:43:14 +02:00
|
|
|
- version:
|
|
|
|
- v13.12.0
|
|
|
|
- v12.17.0
|
2020-03-13 05:28:01 +01:00
|
|
|
pr-url: https://github.com/nodejs/node/pull/32242
|
|
|
|
description: This option is no longer considered experimental.
|
2019-03-22 14:19:46 +01:00
|
|
|
- version: v12.0.0
|
2019-04-19 17:12:28 +02:00
|
|
|
pr-url: https://github.com/nodejs/node/pull/27312
|
|
|
|
description: Changed from `--diagnostic-report-directory` to
|
|
|
|
`--report-directory`
|
|
|
|
-->
|
|
|
|
|
|
|
|
Location at which the report will be generated.
|
|
|
|
|
|
|
|
### `--report-filename=filename`
|
|
|
|
<!-- YAML
|
|
|
|
added: v11.8.0
|
|
|
|
changes:
|
2020-05-01 14:43:14 +02:00
|
|
|
- version:
|
|
|
|
- v13.12.0
|
|
|
|
- v12.17.0
|
2020-03-13 05:28:01 +01:00
|
|
|
pr-url: https://github.com/nodejs/node/pull/32242
|
|
|
|
description: This option is no longer considered experimental.
|
2019-03-22 14:19:46 +01:00
|
|
|
- version: v12.0.0
|
2019-04-19 17:12:28 +02:00
|
|
|
pr-url: https://github.com/nodejs/node/pull/27312
|
|
|
|
description: changed from `--diagnostic-report-filename` to
|
|
|
|
`--report-filename`
|
|
|
|
-->
|
|
|
|
|
|
|
|
Name of the file to which the report will be written.
|
|
|
|
|
|
|
|
### `--report-on-fatalerror`
|
|
|
|
<!-- YAML
|
|
|
|
added: v11.8.0
|
|
|
|
changes:
|
2020-04-28 13:54:04 +02:00
|
|
|
- version:
|
|
|
|
- v14.0.0
|
|
|
|
- v13.14.0
|
2020-05-01 14:43:14 +02:00
|
|
|
- v12.17.0
|
2020-03-26 04:11:56 +01:00
|
|
|
pr-url: https://github.com/nodejs/node/pull/32496
|
|
|
|
description: This option is no longer considered experimental.
|
2019-03-22 14:19:46 +01:00
|
|
|
- version: v12.0.0
|
2019-04-19 17:12:28 +02:00
|
|
|
pr-url: https://github.com/nodejs/node/pull/27312
|
|
|
|
description: changed from `--diagnostic-report-on-fatalerror` to
|
|
|
|
`--report-on-fatalerror`
|
|
|
|
-->
|
|
|
|
|
|
|
|
Enables the report to be triggered on fatal errors (internal errors within
|
|
|
|
the Node.js runtime such as out of memory) that lead to termination of the
|
2020-03-13 04:24:01 +01:00
|
|
|
application. Useful to inspect various diagnostic data elements such as heap,
|
|
|
|
stack, event loop state, resource consumption etc. to reason about the fatal
|
|
|
|
error.
|
2019-04-19 17:12:28 +02:00
|
|
|
|
|
|
|
### `--report-on-signal`
|
|
|
|
<!-- YAML
|
|
|
|
added: v11.8.0
|
|
|
|
changes:
|
2020-05-01 14:43:14 +02:00
|
|
|
- version:
|
|
|
|
- v13.12.0
|
|
|
|
- v12.17.0
|
2020-03-13 05:28:01 +01:00
|
|
|
pr-url: https://github.com/nodejs/node/pull/32242
|
|
|
|
description: This option is no longer considered experimental.
|
2019-03-22 14:19:46 +01:00
|
|
|
- version: v12.0.0
|
2019-04-19 17:12:28 +02:00
|
|
|
pr-url: https://github.com/nodejs/node/pull/27312
|
|
|
|
description: changed from `--diagnostic-report-on-signal` to
|
|
|
|
`--report-on-signal`
|
|
|
|
-->
|
|
|
|
|
|
|
|
Enables report to be generated upon receiving the specified (or predefined)
|
2020-03-13 04:24:01 +01:00
|
|
|
signal to the running Node.js process. The signal to trigger the report is
|
|
|
|
specified through `--report-signal`.
|
2019-04-19 17:12:28 +02:00
|
|
|
|
|
|
|
### `--report-signal=signal`
|
|
|
|
<!-- YAML
|
|
|
|
added: v11.8.0
|
|
|
|
changes:
|
2020-05-01 14:43:14 +02:00
|
|
|
- version:
|
|
|
|
- v13.12.0
|
|
|
|
- v12.17.0
|
2020-03-13 05:28:01 +01:00
|
|
|
pr-url: https://github.com/nodejs/node/pull/32242
|
|
|
|
description: This option is no longer considered experimental.
|
2019-03-22 14:19:46 +01:00
|
|
|
- version: v12.0.0
|
2019-04-19 17:12:28 +02:00
|
|
|
pr-url: https://github.com/nodejs/node/pull/27312
|
|
|
|
description: changed from `--diagnostic-report-signal` to
|
|
|
|
`--report-signal`
|
|
|
|
-->
|
|
|
|
|
|
|
|
Sets or resets the signal for report generation (not supported on Windows).
|
|
|
|
Default signal is `SIGUSR2`.
|
|
|
|
|
|
|
|
### `--report-uncaught-exception`
|
|
|
|
<!-- YAML
|
|
|
|
added: v11.8.0
|
|
|
|
changes:
|
2020-05-01 14:43:14 +02:00
|
|
|
- version:
|
|
|
|
- v13.12.0
|
|
|
|
- v12.17.0
|
2020-03-13 05:28:01 +01:00
|
|
|
pr-url: https://github.com/nodejs/node/pull/32242
|
|
|
|
description: This option is no longer considered experimental.
|
2019-03-22 14:19:46 +01:00
|
|
|
- version: v12.0.0
|
2019-04-19 17:12:28 +02:00
|
|
|
pr-url: https://github.com/nodejs/node/pull/27312
|
|
|
|
description: changed from `--diagnostic-report-uncaught-exception` to
|
|
|
|
`--report-uncaught-exception`
|
|
|
|
-->
|
|
|
|
|
2020-03-13 04:24:01 +01:00
|
|
|
Enables report to be generated on uncaught exceptions. Useful when inspecting
|
|
|
|
the JavaScript stack in conjunction with native stack and other runtime
|
|
|
|
environment data.
|
2019-04-19 17:12:28 +02:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--throw-deprecation`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v0.11.14
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Throw errors for deprecations.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-06-23 01:16:03 +02:00
|
|
|
### `--title=title`
|
|
|
|
<!-- YAML
|
2018-07-17 16:33:02 +02:00
|
|
|
added: v10.7.0
|
2018-06-23 01:16:03 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
Set `process.title` on startup.
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--tls-cipher-list=list`
|
2017-10-19 12:43:40 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v4.0.0
|
2017-10-19 12:43:40 +02:00
|
|
|
-->
|
|
|
|
|
2018-04-29 13:16:44 +02:00
|
|
|
Specify an alternative default TLS cipher list. Requires Node.js to be built
|
|
|
|
with crypto support (default).
|
2017-10-19 12:43:40 +02:00
|
|
|
|
2019-10-22 05:44:20 +02:00
|
|
|
### `--tls-keylog=file`
|
|
|
|
<!-- YAML
|
2020-04-24 18:43:06 +02:00
|
|
|
added:
|
|
|
|
- v13.2.0
|
|
|
|
- v12.16.0
|
2019-10-22 05:44:20 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
Log TLS key material to a file. The key material is in NSS `SSLKEYLOGFILE`
|
|
|
|
format and can be used by software (such as Wireshark) to decrypt the TLS
|
|
|
|
traffic.
|
|
|
|
|
tls: support TLSv1.3
This introduces TLS1.3 support and makes it the default max protocol,
but also supports CLI/NODE_OPTIONS switches to disable it if necessary.
TLS1.3 is a major update to the TLS protocol, with many security
enhancements. It should be preferred over TLS1.2 whenever possible.
TLS1.3 is different enough that even though the OpenSSL APIs are
technically API/ABI compatible, that when TLS1.3 is negotiated, the
timing of protocol records and of callbacks broke assumptions hard-coded
into the 'tls' module.
This change introduces no API incompatibilities when TLS1.2 is
negotiated. It is the intention that it be backported to current and LTS
release lines with the default maximum TLS protocol reset to 'TLSv1.2'.
This will allow users of those lines to explicitly enable TLS1.3 if they
want.
API incompatibilities between TLS1.2 and TLS1.3 are:
- Renegotiation is not supported by TLS1.3 protocol, attempts to call
`.renegotiate()` will always fail.
- Compiling against a system OpenSSL lower than 1.1.1 is no longer
supported (OpenSSL-1.1.0 used to be supported with configure flags).
- Variations of `conn.write('data'); conn.destroy()` have undefined
behaviour according to the streams API. They may or may not send the
'data', and may or may not cause a ERR_STREAM_DESTROYED error to be
emitted. This has always been true, but conditions under which the write
suceeds is slightly but observably different when TLS1.3 is negotiated
vs when TLS1.2 or below is negotiated.
- If TLS1.3 is negotiated, and a server calls `conn.end()` in its
'secureConnection' listener without any data being written, the client
will not receive session tickets (no 'session' events will be emitted,
and `conn.getSession()` will never return a resumable session).
- The return value of `conn.getSession()` API may not return a resumable
session if called right after the handshake. The effect will be that
clients using the legacy `getSession()` API will resume sessions if
TLS1.2 is negotiated, but will do full handshakes if TLS1.3 is
negotiated. See https://github.com/nodejs/node/pull/25831 for more
information.
PR-URL: https://github.com/nodejs/node/pull/26209
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
2018-11-29 02:58:08 +01:00
|
|
|
### `--tls-max-v1.2`
|
2018-10-22 11:40:28 +02:00
|
|
|
<!-- YAML
|
2020-04-24 18:43:06 +02:00
|
|
|
added:
|
|
|
|
- v12.0.0
|
|
|
|
- v10.20.0
|
2018-10-22 11:40:28 +02:00
|
|
|
-->
|
|
|
|
|
2019-03-07 23:51:33 +01:00
|
|
|
Set [`tls.DEFAULT_MAX_VERSION`][] to 'TLSv1.2'. Use to disable support for
|
|
|
|
TLSv1.3.
|
2018-10-22 11:40:28 +02:00
|
|
|
|
tls: support TLSv1.3
This introduces TLS1.3 support and makes it the default max protocol,
but also supports CLI/NODE_OPTIONS switches to disable it if necessary.
TLS1.3 is a major update to the TLS protocol, with many security
enhancements. It should be preferred over TLS1.2 whenever possible.
TLS1.3 is different enough that even though the OpenSSL APIs are
technically API/ABI compatible, that when TLS1.3 is negotiated, the
timing of protocol records and of callbacks broke assumptions hard-coded
into the 'tls' module.
This change introduces no API incompatibilities when TLS1.2 is
negotiated. It is the intention that it be backported to current and LTS
release lines with the default maximum TLS protocol reset to 'TLSv1.2'.
This will allow users of those lines to explicitly enable TLS1.3 if they
want.
API incompatibilities between TLS1.2 and TLS1.3 are:
- Renegotiation is not supported by TLS1.3 protocol, attempts to call
`.renegotiate()` will always fail.
- Compiling against a system OpenSSL lower than 1.1.1 is no longer
supported (OpenSSL-1.1.0 used to be supported with configure flags).
- Variations of `conn.write('data'); conn.destroy()` have undefined
behaviour according to the streams API. They may or may not send the
'data', and may or may not cause a ERR_STREAM_DESTROYED error to be
emitted. This has always been true, but conditions under which the write
suceeds is slightly but observably different when TLS1.3 is negotiated
vs when TLS1.2 or below is negotiated.
- If TLS1.3 is negotiated, and a server calls `conn.end()` in its
'secureConnection' listener without any data being written, the client
will not receive session tickets (no 'session' events will be emitted,
and `conn.getSession()` will never return a resumable session).
- The return value of `conn.getSession()` API may not return a resumable
session if called right after the handshake. The effect will be that
clients using the legacy `getSession()` API will resume sessions if
TLS1.2 is negotiated, but will do full handshakes if TLS1.3 is
negotiated. See https://github.com/nodejs/node/pull/25831 for more
information.
PR-URL: https://github.com/nodejs/node/pull/26209
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
2018-11-29 02:58:08 +01:00
|
|
|
### `--tls-max-v1.3`
|
2018-10-22 11:40:28 +02:00
|
|
|
<!-- YAML
|
2019-03-22 14:19:46 +01:00
|
|
|
added: v12.0.0
|
2018-10-22 11:40:28 +02:00
|
|
|
-->
|
|
|
|
|
2019-03-07 23:51:33 +01:00
|
|
|
Set default [`tls.DEFAULT_MAX_VERSION`][] to 'TLSv1.3'. Use to enable support
|
|
|
|
for TLSv1.3.
|
tls: support TLSv1.3
This introduces TLS1.3 support and makes it the default max protocol,
but also supports CLI/NODE_OPTIONS switches to disable it if necessary.
TLS1.3 is a major update to the TLS protocol, with many security
enhancements. It should be preferred over TLS1.2 whenever possible.
TLS1.3 is different enough that even though the OpenSSL APIs are
technically API/ABI compatible, that when TLS1.3 is negotiated, the
timing of protocol records and of callbacks broke assumptions hard-coded
into the 'tls' module.
This change introduces no API incompatibilities when TLS1.2 is
negotiated. It is the intention that it be backported to current and LTS
release lines with the default maximum TLS protocol reset to 'TLSv1.2'.
This will allow users of those lines to explicitly enable TLS1.3 if they
want.
API incompatibilities between TLS1.2 and TLS1.3 are:
- Renegotiation is not supported by TLS1.3 protocol, attempts to call
`.renegotiate()` will always fail.
- Compiling against a system OpenSSL lower than 1.1.1 is no longer
supported (OpenSSL-1.1.0 used to be supported with configure flags).
- Variations of `conn.write('data'); conn.destroy()` have undefined
behaviour according to the streams API. They may or may not send the
'data', and may or may not cause a ERR_STREAM_DESTROYED error to be
emitted. This has always been true, but conditions under which the write
suceeds is slightly but observably different when TLS1.3 is negotiated
vs when TLS1.2 or below is negotiated.
- If TLS1.3 is negotiated, and a server calls `conn.end()` in its
'secureConnection' listener without any data being written, the client
will not receive session tickets (no 'session' events will be emitted,
and `conn.getSession()` will never return a resumable session).
- The return value of `conn.getSession()` API may not return a resumable
session if called right after the handshake. The effect will be that
clients using the legacy `getSession()` API will resume sessions if
TLS1.2 is negotiated, but will do full handshakes if TLS1.3 is
negotiated. See https://github.com/nodejs/node/pull/25831 for more
information.
PR-URL: https://github.com/nodejs/node/pull/26209
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
2018-11-29 02:58:08 +01:00
|
|
|
|
|
|
|
### `--tls-min-v1.0`
|
|
|
|
<!-- YAML
|
2020-04-24 18:43:06 +02:00
|
|
|
added:
|
|
|
|
- v12.0.0
|
|
|
|
- v10.20.0
|
tls: support TLSv1.3
This introduces TLS1.3 support and makes it the default max protocol,
but also supports CLI/NODE_OPTIONS switches to disable it if necessary.
TLS1.3 is a major update to the TLS protocol, with many security
enhancements. It should be preferred over TLS1.2 whenever possible.
TLS1.3 is different enough that even though the OpenSSL APIs are
technically API/ABI compatible, that when TLS1.3 is negotiated, the
timing of protocol records and of callbacks broke assumptions hard-coded
into the 'tls' module.
This change introduces no API incompatibilities when TLS1.2 is
negotiated. It is the intention that it be backported to current and LTS
release lines with the default maximum TLS protocol reset to 'TLSv1.2'.
This will allow users of those lines to explicitly enable TLS1.3 if they
want.
API incompatibilities between TLS1.2 and TLS1.3 are:
- Renegotiation is not supported by TLS1.3 protocol, attempts to call
`.renegotiate()` will always fail.
- Compiling against a system OpenSSL lower than 1.1.1 is no longer
supported (OpenSSL-1.1.0 used to be supported with configure flags).
- Variations of `conn.write('data'); conn.destroy()` have undefined
behaviour according to the streams API. They may or may not send the
'data', and may or may not cause a ERR_STREAM_DESTROYED error to be
emitted. This has always been true, but conditions under which the write
suceeds is slightly but observably different when TLS1.3 is negotiated
vs when TLS1.2 or below is negotiated.
- If TLS1.3 is negotiated, and a server calls `conn.end()` in its
'secureConnection' listener without any data being written, the client
will not receive session tickets (no 'session' events will be emitted,
and `conn.getSession()` will never return a resumable session).
- The return value of `conn.getSession()` API may not return a resumable
session if called right after the handshake. The effect will be that
clients using the legacy `getSession()` API will resume sessions if
TLS1.2 is negotiated, but will do full handshakes if TLS1.3 is
negotiated. See https://github.com/nodejs/node/pull/25831 for more
information.
PR-URL: https://github.com/nodejs/node/pull/26209
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
2018-11-29 02:58:08 +01:00
|
|
|
-->
|
|
|
|
|
2019-03-07 23:51:33 +01:00
|
|
|
Set default [`tls.DEFAULT_MIN_VERSION`][] to 'TLSv1'. Use for compatibility with
|
|
|
|
old TLS clients or servers.
|
tls: support TLSv1.3
This introduces TLS1.3 support and makes it the default max protocol,
but also supports CLI/NODE_OPTIONS switches to disable it if necessary.
TLS1.3 is a major update to the TLS protocol, with many security
enhancements. It should be preferred over TLS1.2 whenever possible.
TLS1.3 is different enough that even though the OpenSSL APIs are
technically API/ABI compatible, that when TLS1.3 is negotiated, the
timing of protocol records and of callbacks broke assumptions hard-coded
into the 'tls' module.
This change introduces no API incompatibilities when TLS1.2 is
negotiated. It is the intention that it be backported to current and LTS
release lines with the default maximum TLS protocol reset to 'TLSv1.2'.
This will allow users of those lines to explicitly enable TLS1.3 if they
want.
API incompatibilities between TLS1.2 and TLS1.3 are:
- Renegotiation is not supported by TLS1.3 protocol, attempts to call
`.renegotiate()` will always fail.
- Compiling against a system OpenSSL lower than 1.1.1 is no longer
supported (OpenSSL-1.1.0 used to be supported with configure flags).
- Variations of `conn.write('data'); conn.destroy()` have undefined
behaviour according to the streams API. They may or may not send the
'data', and may or may not cause a ERR_STREAM_DESTROYED error to be
emitted. This has always been true, but conditions under which the write
suceeds is slightly but observably different when TLS1.3 is negotiated
vs when TLS1.2 or below is negotiated.
- If TLS1.3 is negotiated, and a server calls `conn.end()` in its
'secureConnection' listener without any data being written, the client
will not receive session tickets (no 'session' events will be emitted,
and `conn.getSession()` will never return a resumable session).
- The return value of `conn.getSession()` API may not return a resumable
session if called right after the handshake. The effect will be that
clients using the legacy `getSession()` API will resume sessions if
TLS1.2 is negotiated, but will do full handshakes if TLS1.3 is
negotiated. See https://github.com/nodejs/node/pull/25831 for more
information.
PR-URL: https://github.com/nodejs/node/pull/26209
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
2018-11-29 02:58:08 +01:00
|
|
|
|
|
|
|
### `--tls-min-v1.1`
|
|
|
|
<!-- YAML
|
2020-04-24 18:43:06 +02:00
|
|
|
added:
|
|
|
|
- v12.0.0
|
|
|
|
- v10.20.0
|
tls: support TLSv1.3
This introduces TLS1.3 support and makes it the default max protocol,
but also supports CLI/NODE_OPTIONS switches to disable it if necessary.
TLS1.3 is a major update to the TLS protocol, with many security
enhancements. It should be preferred over TLS1.2 whenever possible.
TLS1.3 is different enough that even though the OpenSSL APIs are
technically API/ABI compatible, that when TLS1.3 is negotiated, the
timing of protocol records and of callbacks broke assumptions hard-coded
into the 'tls' module.
This change introduces no API incompatibilities when TLS1.2 is
negotiated. It is the intention that it be backported to current and LTS
release lines with the default maximum TLS protocol reset to 'TLSv1.2'.
This will allow users of those lines to explicitly enable TLS1.3 if they
want.
API incompatibilities between TLS1.2 and TLS1.3 are:
- Renegotiation is not supported by TLS1.3 protocol, attempts to call
`.renegotiate()` will always fail.
- Compiling against a system OpenSSL lower than 1.1.1 is no longer
supported (OpenSSL-1.1.0 used to be supported with configure flags).
- Variations of `conn.write('data'); conn.destroy()` have undefined
behaviour according to the streams API. They may or may not send the
'data', and may or may not cause a ERR_STREAM_DESTROYED error to be
emitted. This has always been true, but conditions under which the write
suceeds is slightly but observably different when TLS1.3 is negotiated
vs when TLS1.2 or below is negotiated.
- If TLS1.3 is negotiated, and a server calls `conn.end()` in its
'secureConnection' listener without any data being written, the client
will not receive session tickets (no 'session' events will be emitted,
and `conn.getSession()` will never return a resumable session).
- The return value of `conn.getSession()` API may not return a resumable
session if called right after the handshake. The effect will be that
clients using the legacy `getSession()` API will resume sessions if
TLS1.2 is negotiated, but will do full handshakes if TLS1.3 is
negotiated. See https://github.com/nodejs/node/pull/25831 for more
information.
PR-URL: https://github.com/nodejs/node/pull/26209
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
2018-11-29 02:58:08 +01:00
|
|
|
-->
|
|
|
|
|
2019-03-07 23:51:33 +01:00
|
|
|
Set default [`tls.DEFAULT_MIN_VERSION`][] to 'TLSv1.1'. Use for compatibility
|
|
|
|
with old TLS clients or servers.
|
tls: support TLSv1.3
This introduces TLS1.3 support and makes it the default max protocol,
but also supports CLI/NODE_OPTIONS switches to disable it if necessary.
TLS1.3 is a major update to the TLS protocol, with many security
enhancements. It should be preferred over TLS1.2 whenever possible.
TLS1.3 is different enough that even though the OpenSSL APIs are
technically API/ABI compatible, that when TLS1.3 is negotiated, the
timing of protocol records and of callbacks broke assumptions hard-coded
into the 'tls' module.
This change introduces no API incompatibilities when TLS1.2 is
negotiated. It is the intention that it be backported to current and LTS
release lines with the default maximum TLS protocol reset to 'TLSv1.2'.
This will allow users of those lines to explicitly enable TLS1.3 if they
want.
API incompatibilities between TLS1.2 and TLS1.3 are:
- Renegotiation is not supported by TLS1.3 protocol, attempts to call
`.renegotiate()` will always fail.
- Compiling against a system OpenSSL lower than 1.1.1 is no longer
supported (OpenSSL-1.1.0 used to be supported with configure flags).
- Variations of `conn.write('data'); conn.destroy()` have undefined
behaviour according to the streams API. They may or may not send the
'data', and may or may not cause a ERR_STREAM_DESTROYED error to be
emitted. This has always been true, but conditions under which the write
suceeds is slightly but observably different when TLS1.3 is negotiated
vs when TLS1.2 or below is negotiated.
- If TLS1.3 is negotiated, and a server calls `conn.end()` in its
'secureConnection' listener without any data being written, the client
will not receive session tickets (no 'session' events will be emitted,
and `conn.getSession()` will never return a resumable session).
- The return value of `conn.getSession()` API may not return a resumable
session if called right after the handshake. The effect will be that
clients using the legacy `getSession()` API will resume sessions if
TLS1.2 is negotiated, but will do full handshakes if TLS1.3 is
negotiated. See https://github.com/nodejs/node/pull/25831 for more
information.
PR-URL: https://github.com/nodejs/node/pull/26209
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
2018-11-29 02:58:08 +01:00
|
|
|
|
2019-05-01 20:45:45 +02:00
|
|
|
### `--tls-min-v1.2`
|
|
|
|
<!-- YAML
|
2020-04-24 18:43:06 +02:00
|
|
|
added:
|
|
|
|
- v12.2.0
|
|
|
|
- v10.20.0
|
2019-05-01 20:45:45 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
Set default [`tls.DEFAULT_MIN_VERSION`][] to 'TLSv1.2'. This is the default for
|
|
|
|
12.x and later, but the option is supported for compatibility with older Node.js
|
|
|
|
versions.
|
|
|
|
|
tls: support TLSv1.3
This introduces TLS1.3 support and makes it the default max protocol,
but also supports CLI/NODE_OPTIONS switches to disable it if necessary.
TLS1.3 is a major update to the TLS protocol, with many security
enhancements. It should be preferred over TLS1.2 whenever possible.
TLS1.3 is different enough that even though the OpenSSL APIs are
technically API/ABI compatible, that when TLS1.3 is negotiated, the
timing of protocol records and of callbacks broke assumptions hard-coded
into the 'tls' module.
This change introduces no API incompatibilities when TLS1.2 is
negotiated. It is the intention that it be backported to current and LTS
release lines with the default maximum TLS protocol reset to 'TLSv1.2'.
This will allow users of those lines to explicitly enable TLS1.3 if they
want.
API incompatibilities between TLS1.2 and TLS1.3 are:
- Renegotiation is not supported by TLS1.3 protocol, attempts to call
`.renegotiate()` will always fail.
- Compiling against a system OpenSSL lower than 1.1.1 is no longer
supported (OpenSSL-1.1.0 used to be supported with configure flags).
- Variations of `conn.write('data'); conn.destroy()` have undefined
behaviour according to the streams API. They may or may not send the
'data', and may or may not cause a ERR_STREAM_DESTROYED error to be
emitted. This has always been true, but conditions under which the write
suceeds is slightly but observably different when TLS1.3 is negotiated
vs when TLS1.2 or below is negotiated.
- If TLS1.3 is negotiated, and a server calls `conn.end()` in its
'secureConnection' listener without any data being written, the client
will not receive session tickets (no 'session' events will be emitted,
and `conn.getSession()` will never return a resumable session).
- The return value of `conn.getSession()` API may not return a resumable
session if called right after the handshake. The effect will be that
clients using the legacy `getSession()` API will resume sessions if
TLS1.2 is negotiated, but will do full handshakes if TLS1.3 is
negotiated. See https://github.com/nodejs/node/pull/25831 for more
information.
PR-URL: https://github.com/nodejs/node/pull/26209
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
2018-11-29 02:58:08 +01:00
|
|
|
### `--tls-min-v1.3`
|
|
|
|
<!-- YAML
|
2019-03-22 14:19:46 +01:00
|
|
|
added: v12.0.0
|
tls: support TLSv1.3
This introduces TLS1.3 support and makes it the default max protocol,
but also supports CLI/NODE_OPTIONS switches to disable it if necessary.
TLS1.3 is a major update to the TLS protocol, with many security
enhancements. It should be preferred over TLS1.2 whenever possible.
TLS1.3 is different enough that even though the OpenSSL APIs are
technically API/ABI compatible, that when TLS1.3 is negotiated, the
timing of protocol records and of callbacks broke assumptions hard-coded
into the 'tls' module.
This change introduces no API incompatibilities when TLS1.2 is
negotiated. It is the intention that it be backported to current and LTS
release lines with the default maximum TLS protocol reset to 'TLSv1.2'.
This will allow users of those lines to explicitly enable TLS1.3 if they
want.
API incompatibilities between TLS1.2 and TLS1.3 are:
- Renegotiation is not supported by TLS1.3 protocol, attempts to call
`.renegotiate()` will always fail.
- Compiling against a system OpenSSL lower than 1.1.1 is no longer
supported (OpenSSL-1.1.0 used to be supported with configure flags).
- Variations of `conn.write('data'); conn.destroy()` have undefined
behaviour according to the streams API. They may or may not send the
'data', and may or may not cause a ERR_STREAM_DESTROYED error to be
emitted. This has always been true, but conditions under which the write
suceeds is slightly but observably different when TLS1.3 is negotiated
vs when TLS1.2 or below is negotiated.
- If TLS1.3 is negotiated, and a server calls `conn.end()` in its
'secureConnection' listener without any data being written, the client
will not receive session tickets (no 'session' events will be emitted,
and `conn.getSession()` will never return a resumable session).
- The return value of `conn.getSession()` API may not return a resumable
session if called right after the handshake. The effect will be that
clients using the legacy `getSession()` API will resume sessions if
TLS1.2 is negotiated, but will do full handshakes if TLS1.3 is
negotiated. See https://github.com/nodejs/node/pull/25831 for more
information.
PR-URL: https://github.com/nodejs/node/pull/26209
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rod Vagg <rod@vagg.org>
2018-11-29 02:58:08 +01:00
|
|
|
-->
|
|
|
|
|
2019-03-07 23:51:33 +01:00
|
|
|
Set default [`tls.DEFAULT_MIN_VERSION`][] to 'TLSv1.3'. Use to disable support
|
|
|
|
for TLSv1.2, which is not as secure as TLSv1.3.
|
2018-10-22 11:40:28 +02:00
|
|
|
|
2019-12-06 00:39:16 +01:00
|
|
|
### `--trace-atomics-wait`
|
|
|
|
<!-- YAML
|
2020-05-18 03:45:37 +02:00
|
|
|
added: v14.3.0
|
2019-12-06 00:39:16 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
Print short summaries of calls to [`Atomics.wait()`][] to stderr.
|
|
|
|
The output could look like this:
|
|
|
|
|
|
|
|
```text
|
|
|
|
(node:15701) [Thread 0] Atomics.wait(<address> + 0, 1, inf) started
|
|
|
|
(node:15701) [Thread 0] Atomics.wait(<address> + 0, 1, inf) did not wait because the values mismatched
|
|
|
|
(node:15701) [Thread 0] Atomics.wait(<address> + 0, 0, 10) started
|
|
|
|
(node:15701) [Thread 0] Atomics.wait(<address> + 0, 0, 10) timed out
|
|
|
|
(node:15701) [Thread 0] Atomics.wait(<address> + 4, 0, inf) started
|
|
|
|
(node:15701) [Thread 1] Atomics.wait(<address> + 4, -1, inf) started
|
|
|
|
(node:15701) [Thread 0] Atomics.wait(<address> + 4, 0, inf) was woken up by another thread
|
|
|
|
(node:15701) [Thread 1] Atomics.wait(<address> + 4, -1, inf) was woken up by another thread
|
|
|
|
```
|
|
|
|
|
|
|
|
The fields here correspond to:
|
|
|
|
|
|
|
|
* The thread id as given by [`worker_threads.threadId`][]
|
|
|
|
* The base address of the `SharedArrayBuffer` in question, as well as the
|
|
|
|
byte offset corresponding to the index passed to `Atomics.wait()`
|
|
|
|
* The expected value that was passed to `Atomics.wait()`
|
|
|
|
* The timeout passed to `Atomics.wait`
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--trace-deprecation`
|
2016-08-05 23:04:25 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v0.8.0
|
2016-08-05 23:04:25 +02:00
|
|
|
-->
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Print stack traces for deprecations.
|
|
|
|
|
2016-08-05 23:04:25 +02:00
|
|
|
### `--trace-event-categories`
|
|
|
|
<!-- YAML
|
2017-02-28 04:49:09 +01:00
|
|
|
added: v7.7.0
|
2016-08-05 23:04:25 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
A comma separated list of categories that should be traced when trace event
|
|
|
|
tracing is enabled using `--trace-events-enabled`.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-01-31 17:12:09 +01:00
|
|
|
### `--trace-event-file-pattern`
|
|
|
|
<!-- YAML
|
2018-03-06 22:58:16 +01:00
|
|
|
added: v9.8.0
|
2018-01-31 17:12:09 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
Template string specifying the filepath for the trace event data, it
|
|
|
|
supports `${rotation}` and `${pid}`.
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--trace-events-enabled`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v7.7.0
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Enables the collection of trace event tracing information.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2019-11-17 13:02:01 +01:00
|
|
|
### `--trace-exit`
|
|
|
|
<!-- YAML
|
2020-04-24 18:43:06 +02:00
|
|
|
added:
|
|
|
|
- v13.5.0
|
|
|
|
- v12.16.0
|
2019-11-17 13:02:01 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
Prints a stack trace whenever an environment is exited proactively,
|
|
|
|
i.e. invoking `process.exit()`.
|
|
|
|
|
2019-08-19 15:03:08 +02:00
|
|
|
### `--trace-sigint`
|
|
|
|
<!-- YAML
|
2020-05-01 14:43:14 +02:00
|
|
|
added:
|
|
|
|
- v13.9.0
|
|
|
|
- v12.17.0
|
2019-08-19 15:03:08 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
Prints a stack trace on SIGINT.
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--trace-sync-io`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v2.1.0
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-05-03 01:31:20 +02:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Prints a stack trace whenever synchronous I/O is detected after the first turn
|
|
|
|
of the event loop.
|
2016-05-03 01:31:20 +02:00
|
|
|
|
2019-04-30 18:19:10 +02:00
|
|
|
### `--trace-tls`
|
|
|
|
<!-- YAML
|
2019-05-06 14:40:25 +02:00
|
|
|
added: v12.2.0
|
2019-04-30 18:19:10 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
Prints TLS packet trace information to `stderr`. This can be used to debug TLS
|
|
|
|
connection problems.
|
|
|
|
|
2019-10-18 17:05:35 +02:00
|
|
|
### `--trace-uncaught`
|
|
|
|
<!-- YAML
|
2019-11-05 10:55:13 +01:00
|
|
|
added: v13.1.0
|
2019-10-18 17:05:35 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
Print stack traces for uncaught exceptions; usually, the stack trace associated
|
|
|
|
with the creation of an `Error` is printed, whereas this makes Node.js also
|
|
|
|
print the stack trace associated with throwing the value (which does not need
|
|
|
|
to be an `Error` instance).
|
|
|
|
|
|
|
|
Enabling this option may affect garbage collection behavior negatively.
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--trace-warnings`
|
|
|
|
<!-- YAML
|
|
|
|
added: v6.0.0
|
|
|
|
-->
|
2016-05-03 01:31:20 +02:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Print stack traces for process warnings (including deprecations).
|
2016-05-03 01:31:20 +02:00
|
|
|
|
2016-03-18 18:26:41 +01:00
|
|
|
### `--track-heap-objects`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
|
|
|
added: v2.4.0
|
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
|
|
|
Track heap object allocations for heap snapshots.
|
|
|
|
|
2019-03-11 20:46:43 +01:00
|
|
|
### `--unhandled-rejections=mode`
|
|
|
|
<!-- YAML
|
2020-04-24 18:43:06 +02:00
|
|
|
added:
|
|
|
|
- v12.0.0
|
|
|
|
- v10.17.0
|
2019-03-11 20:46:43 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
By default all unhandled rejections trigger a warning plus a deprecation warning
|
|
|
|
for the very first unhandled rejection in case no [`unhandledRejection`][] hook
|
|
|
|
is used.
|
|
|
|
|
|
|
|
Using this flag allows to change what should happen when an unhandled rejection
|
2020-05-20 02:41:01 +02:00
|
|
|
occurs. One of the following modes can be chosen:
|
2019-03-11 20:46:43 +01:00
|
|
|
|
2020-05-20 02:41:01 +02:00
|
|
|
* `throw`: Emit [`unhandledRejection`][]. If this hook is not set, raise the
|
|
|
|
unhandled rejection as an uncaught exception.
|
2019-03-11 20:46:43 +01:00
|
|
|
* `strict`: Raise the unhandled rejection as an uncaught exception.
|
|
|
|
* `warn`: Always trigger a warning, no matter if the [`unhandledRejection`][]
|
|
|
|
hook is set or not but do not print the deprecation warning.
|
2020-05-20 02:41:01 +02:00
|
|
|
* `warn-with-error-code`: Emit [`unhandledRejection`][]. If this hook is not
|
|
|
|
set, trigger a warning, and set the process exit code to 1.
|
2019-03-11 20:46:43 +01:00
|
|
|
* `none`: Silence all warnings.
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--use-bundled-ca`, `--use-openssl-ca`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v6.11.0
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Use bundled Mozilla CA store as supplied by current Node.js version
|
|
|
|
or use OpenSSL's default CA store. The default store is selectable
|
|
|
|
at build-time.
|
|
|
|
|
|
|
|
The bundled CA store, as supplied by Node.js, is a snapshot of Mozilla CA store
|
|
|
|
that is fixed at release time. It is identical on all supported platforms.
|
|
|
|
|
|
|
|
Using OpenSSL store allows for external modifications of the store. For most
|
|
|
|
Linux and BSD distributions, this store is maintained by the distribution
|
|
|
|
maintainers and system administrators. OpenSSL CA store location is dependent on
|
|
|
|
configuration of the OpenSSL library but this can be altered at runtime using
|
|
|
|
environment variables.
|
|
|
|
|
|
|
|
See `SSL_CERT_DIR` and `SSL_CERT_FILE`.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2019-12-13 20:59:37 +01:00
|
|
|
### `--use-largepages=mode`
|
|
|
|
<!-- YAML
|
2020-05-01 14:43:14 +02:00
|
|
|
added:
|
|
|
|
- v13.6.0
|
|
|
|
- v12.17.0
|
2019-12-13 20:59:37 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
Re-map the Node.js static code to large memory pages at startup. If supported on
|
|
|
|
the target system, this will cause the Node.js static code to be moved onto 2
|
|
|
|
MiB pages instead of 4 KiB pages.
|
|
|
|
|
|
|
|
The following values are valid for `mode`:
|
|
|
|
* `off`: No mapping will be attempted. This is the default.
|
|
|
|
* `on`: If supported by the OS, mapping will be attempted. Failure to map will
|
|
|
|
be ignored and a message will be printed to standard error.
|
|
|
|
* `silent`: If supported by the OS, mapping will be attempted. Failure to map
|
|
|
|
will be ignored and will not be reported.
|
|
|
|
|
2016-03-18 18:26:41 +01:00
|
|
|
### `--v8-options`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
|
|
|
added: v0.1.3
|
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2017-11-17 06:41:14 +01:00
|
|
|
Print V8 command line options.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `--v8-pool-size=num`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v5.10.0
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Set V8's thread pool size which will be used to allocate background jobs.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
If set to `0` then V8 will choose an appropriate size of the thread pool based
|
|
|
|
on the number of online processors.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
If the value provided is larger than V8's maximum, then the largest value
|
|
|
|
will be chosen.
|
|
|
|
|
|
|
|
### `--zero-fill-buffers`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
|
|
|
added: v6.0.0
|
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-16 23:59:39 +02:00
|
|
|
Automatically zero-fills all newly allocated [`Buffer`][] and [`SlowBuffer`][]
|
2018-04-08 08:33:19 +02:00
|
|
|
instances.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `-c`, `--check`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added:
|
|
|
|
- v5.0.0
|
|
|
|
- v4.2.0
|
|
|
|
changes:
|
2018-03-02 18:53:46 +01:00
|
|
|
- version: v10.0.0
|
2018-04-08 08:33:19 +02:00
|
|
|
pr-url: https://github.com/nodejs/node/pull/19600
|
|
|
|
description: The `--require` option is now supported when checking a file.
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Syntax check the script without executing.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `-e`, `--eval "script"`
|
2016-10-18 07:35:22 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v0.5.2
|
|
|
|
changes:
|
|
|
|
- version: v5.11.0
|
|
|
|
pr-url: https://github.com/nodejs/node/pull/5348
|
|
|
|
description: Built-in libraries are now available as predefined variables.
|
2016-10-18 07:35:22 +02:00
|
|
|
-->
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Evaluate the following argument as JavaScript. The modules which are
|
|
|
|
predefined in the REPL can also be used in `script`.
|
2016-10-18 07:35:22 +02:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
On Windows, using `cmd.exe` a single quote will not work correctly because it
|
|
|
|
only recognizes double `"` for quoting. In Powershell or Git bash, both `'`
|
|
|
|
and `"` are usable.
|
|
|
|
|
|
|
|
### `-h`, `--help`
|
2016-12-21 11:16:39 +01:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v0.1.3
|
2016-12-21 11:16:39 +01:00
|
|
|
-->
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Print node command line options.
|
|
|
|
The output of this option is less detailed than this document.
|
2016-12-21 11:16:39 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `-i`, `--interactive`
|
|
|
|
<!-- YAML
|
|
|
|
added: v0.7.7
|
|
|
|
-->
|
2016-12-21 11:16:39 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Opens the REPL even if stdin does not appear to be a terminal.
|
2016-10-18 07:35:22 +02:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `-p`, `--print "script"`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v0.6.4
|
|
|
|
changes:
|
|
|
|
- version: v5.11.0
|
|
|
|
pr-url: https://github.com/nodejs/node/pull/5348
|
|
|
|
description: Built-in libraries are now available as predefined variables.
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Identical to `-e` but prints the result.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `-r`, `--require module`
|
2017-05-13 09:58:18 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v1.6.0
|
2017-05-13 09:58:18 +02:00
|
|
|
-->
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
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.
|
2017-05-13 09:58:18 +02:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `-v`, `--version`
|
2016-12-30 06:28:38 +01:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v0.1.3
|
2016-12-30 06:28:38 +01:00
|
|
|
-->
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
Print node's version.
|
2016-12-30 06:28:38 +01:00
|
|
|
|
2020-06-14 23:49:34 +02:00
|
|
|
## Environment variables
|
2016-03-18 18:26:41 +01:00
|
|
|
|
|
|
|
### `NODE_DEBUG=module[,…]`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
|
|
|
added: v0.1.32
|
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
|
|
|
`','`-separated list of core modules that should print debug information.
|
|
|
|
|
2018-11-15 22:40:06 +01:00
|
|
|
### `NODE_DEBUG_NATIVE=module[,…]`
|
|
|
|
|
|
|
|
`','`-separated list of core C++ modules that should print debug information.
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `NODE_DISABLE_COLORS=1`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v0.3.0
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2019-03-08 12:21:35 +01:00
|
|
|
When set, colors will not be used in the REPL.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `NODE_EXTRA_CA_CERTS=file`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v7.3.0
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
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 emitted (once) with
|
|
|
|
[`process.emitWarning()`][emit_warning] if the file is missing or
|
|
|
|
malformed, but any errors are otherwise ignored.
|
|
|
|
|
2019-06-20 22:07:01 +02:00
|
|
|
Neither the well known nor extra certificates are used when the `ca`
|
2018-04-08 08:33:19 +02:00
|
|
|
options property is explicitly specified for a TLS or HTTPS client or server.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-10-19 23:39:46 +02:00
|
|
|
This environment variable is ignored when `node` runs as setuid root or
|
|
|
|
has Linux file capabilities set.
|
|
|
|
|
2016-03-18 18:26:41 +01:00
|
|
|
### `NODE_ICU_DATA=file`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
|
|
|
added: v0.11.15
|
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-29 19:46:41 +02:00
|
|
|
Data path for ICU (`Intl` object) data. Will extend linked-in data when compiled
|
2016-03-18 18:26:41 +01:00
|
|
|
with small-icu support.
|
|
|
|
|
2017-01-16 22:57:36 +01:00
|
|
|
### `NODE_NO_WARNINGS=1`
|
|
|
|
<!-- YAML
|
2017-05-16 20:05:47 +02:00
|
|
|
added: v6.11.0
|
2017-01-16 22:57:36 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
When set to `1`, process warnings are silenced.
|
|
|
|
|
2017-02-20 15:18:43 +01:00
|
|
|
### `NODE_OPTIONS=options...`
|
|
|
|
<!-- YAML
|
2017-03-16 04:26:14 +01:00
|
|
|
added: v8.0.0
|
2017-02-20 15:18:43 +01:00
|
|
|
-->
|
|
|
|
|
2019-08-01 20:04:47 +02:00
|
|
|
A space-separated list of command line options. `options...` are interpreted
|
|
|
|
before command line options, so command line options will override or
|
|
|
|
compound after anything in `options...`. Node.js will exit with an error if
|
|
|
|
an option that is not allowed in the environment is used, such as `-p` or a
|
|
|
|
script file.
|
2017-02-20 15:18:43 +01:00
|
|
|
|
2019-08-01 20:04:47 +02:00
|
|
|
In case an option value happens to contain a space (for example a path listed
|
|
|
|
in `--require`), it must be escaped using double quotes. For example:
|
2018-11-03 18:52:44 +01:00
|
|
|
|
|
|
|
```bash
|
2019-08-01 20:04:47 +02:00
|
|
|
NODE_OPTIONS='--require "./my path/file.js"'
|
|
|
|
```
|
|
|
|
|
|
|
|
A singleton flag passed as a command line option will override the same flag
|
|
|
|
passed into `NODE_OPTIONS`:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
# The inspector will be available on port 5555
|
|
|
|
NODE_OPTIONS='--inspect=localhost:4444' node --inspect=localhost:5555
|
|
|
|
```
|
|
|
|
|
|
|
|
A flag that can be passed multiple times will be treated as if its
|
|
|
|
`NODE_OPTIONS` instances were passed first, and then its command line
|
|
|
|
instances afterwards:
|
|
|
|
|
|
|
|
```bash
|
|
|
|
NODE_OPTIONS='--require "./a.js"' node --require "./b.js"
|
|
|
|
# is equivalent to:
|
|
|
|
node --require "./a.js" --require "./b.js"
|
2018-11-03 18:52:44 +01:00
|
|
|
```
|
|
|
|
|
2018-10-30 06:04:25 +01:00
|
|
|
Node.js options that are allowed are:
|
2019-06-11 20:17:15 +02:00
|
|
|
<!-- node-options-node start -->
|
2020-03-15 01:54:15 +01:00
|
|
|
* `--disable-proto`
|
2019-09-13 06:22:29 +02:00
|
|
|
* `--enable-fips`
|
2019-09-29 23:15:39 +02:00
|
|
|
* `--enable-source-maps`
|
2020-05-23 03:11:14 +02:00
|
|
|
* `--experimental-abortcontroller`
|
2019-12-19 22:25:52 +01:00
|
|
|
* `--experimental-import-meta-resolve`
|
2019-09-28 21:01:23 +02:00
|
|
|
* `--experimental-json-modules`
|
2019-09-28 18:51:15 +02:00
|
|
|
* `--experimental-loader`
|
2019-09-13 06:22:29 +02:00
|
|
|
* `--experimental-modules`
|
|
|
|
* `--experimental-policy`
|
|
|
|
* `--experimental-repl-await`
|
2019-11-27 07:54:23 +01:00
|
|
|
* `--experimental-specifier-resolution`
|
2020-05-21 10:22:53 +02:00
|
|
|
* `--experimental-top-level-await`
|
2019-09-13 06:22:29 +02:00
|
|
|
* `--experimental-vm-modules`
|
2019-12-15 17:30:45 +01:00
|
|
|
* `--experimental-wasi-unstable-preview1`
|
2019-09-13 06:22:29 +02:00
|
|
|
* `--experimental-wasm-modules`
|
2019-09-20 07:16:04 +02:00
|
|
|
* `--force-context-aware`
|
2019-09-13 06:22:29 +02:00
|
|
|
* `--force-fips`
|
|
|
|
* `--frozen-intrinsics`
|
|
|
|
* `--heapsnapshot-signal`
|
|
|
|
* `--http-parser`
|
|
|
|
* `--icu-data-dir`
|
|
|
|
* `--input-type`
|
2019-11-20 20:48:58 +01:00
|
|
|
* `--insecure-http-parser`
|
2019-09-13 06:22:29 +02:00
|
|
|
* `--inspect-brk`
|
|
|
|
* `--inspect-port`, `--debug-port`
|
|
|
|
* `--inspect-publish-uid`
|
|
|
|
* `--inspect`
|
|
|
|
* `--max-http-header-size`
|
|
|
|
* `--napi-modules`
|
|
|
|
* `--no-deprecation`
|
|
|
|
* `--no-force-async-hooks-checks`
|
|
|
|
* `--no-warnings`
|
|
|
|
* `--openssl-config`
|
|
|
|
* `--pending-deprecation`
|
|
|
|
* `--policy-integrity`
|
|
|
|
* `--preserve-symlinks-main`
|
|
|
|
* `--preserve-symlinks`
|
|
|
|
* `--prof-process`
|
|
|
|
* `--redirect-warnings`
|
2020-03-13 17:45:39 +01:00
|
|
|
* `--report-compact`
|
2020-05-27 17:05:17 +02:00
|
|
|
* `--report-dir`, `--report-directory`
|
2019-09-13 06:22:29 +02:00
|
|
|
* `--report-filename`
|
|
|
|
* `--report-on-fatalerror`
|
|
|
|
* `--report-on-signal`
|
|
|
|
* `--report-signal`
|
|
|
|
* `--report-uncaught-exception`
|
|
|
|
* `--require`, `-r`
|
|
|
|
* `--throw-deprecation`
|
|
|
|
* `--title`
|
|
|
|
* `--tls-cipher-list`
|
2019-10-22 05:44:20 +02:00
|
|
|
* `--tls-keylog`
|
2019-09-13 06:22:29 +02:00
|
|
|
* `--tls-max-v1.2`
|
|
|
|
* `--tls-max-v1.3`
|
|
|
|
* `--tls-min-v1.0`
|
|
|
|
* `--tls-min-v1.1`
|
|
|
|
* `--tls-min-v1.2`
|
|
|
|
* `--tls-min-v1.3`
|
2019-12-06 00:39:16 +01:00
|
|
|
* `--trace-atomics-wait`
|
2019-09-13 06:22:29 +02:00
|
|
|
* `--trace-deprecation`
|
|
|
|
* `--trace-event-categories`
|
|
|
|
* `--trace-event-file-pattern`
|
|
|
|
* `--trace-events-enabled`
|
2019-11-17 13:02:01 +01:00
|
|
|
* `--trace-exit`
|
2019-08-19 15:03:08 +02:00
|
|
|
* `--trace-sigint`
|
2019-09-13 06:22:29 +02:00
|
|
|
* `--trace-sync-io`
|
|
|
|
* `--trace-tls`
|
2019-10-18 17:05:35 +02:00
|
|
|
* `--trace-uncaught`
|
2019-09-13 06:22:29 +02:00
|
|
|
* `--trace-warnings`
|
|
|
|
* `--track-heap-objects`
|
|
|
|
* `--unhandled-rejections`
|
|
|
|
* `--use-bundled-ca`
|
2019-12-13 20:59:37 +01:00
|
|
|
* `--use-largepages`
|
2019-09-13 06:22:29 +02:00
|
|
|
* `--use-openssl-ca`
|
|
|
|
* `--v8-pool-size`
|
|
|
|
* `--zero-fill-buffers`
|
2019-06-11 20:17:15 +02:00
|
|
|
<!-- node-options-node end -->
|
2017-02-20 15:18:43 +01:00
|
|
|
|
|
|
|
V8 options that are allowed are:
|
2019-06-11 20:17:15 +02:00
|
|
|
<!-- node-options-v8 start -->
|
2019-09-13 06:22:29 +02:00
|
|
|
* `--abort-on-uncaught-exception`
|
2019-10-23 20:06:57 +02:00
|
|
|
* `--disallow-code-generation-from-strings`
|
2020-03-13 17:28:19 +01:00
|
|
|
* `--huge-max-old-generation-size`
|
2019-09-13 06:22:29 +02:00
|
|
|
* `--interpreted-frames-native-stack`
|
2020-03-05 00:34:28 +01:00
|
|
|
* `--jitless`
|
2019-09-13 06:22:29 +02:00
|
|
|
* `--max-old-space-size`
|
|
|
|
* `--perf-basic-prof-only-functions`
|
|
|
|
* `--perf-basic-prof`
|
|
|
|
* `--perf-prof-unwinding-info`
|
|
|
|
* `--perf-prof`
|
|
|
|
* `--stack-trace-limit`
|
2019-06-11 20:17:15 +02:00
|
|
|
<!-- node-options-v8 end -->
|
2017-02-20 15:18:43 +01:00
|
|
|
|
2020-02-21 01:58:58 +01:00
|
|
|
`--perf-basic-prof-only-functions`, `--perf-basic-prof`,
|
|
|
|
`--perf-prof-unwinding-info`, and `--perf-prof` are only available on Linux.
|
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `NODE_PATH=path[:…]`
|
|
|
|
<!-- YAML
|
|
|
|
added: v0.1.32
|
|
|
|
-->
|
|
|
|
|
|
|
|
`':'`-separated list of directories prefixed to the module search path.
|
|
|
|
|
|
|
|
On Windows, this is a `';'`-separated list instead.
|
|
|
|
|
2017-03-11 21:18:53 +01:00
|
|
|
### `NODE_PENDING_DEPRECATION=1`
|
|
|
|
<!-- YAML
|
2017-03-16 04:26:14 +01:00
|
|
|
added: v8.0.0
|
2017-03-11 21:18:53 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
When set to `1`, emit pending deprecation warnings.
|
|
|
|
|
2018-02-06 06:55:16 +01:00
|
|
|
Pending deprecations are generally identical to a runtime deprecation with the
|
|
|
|
notable exception that they are turned *off* by default and will not be emitted
|
|
|
|
unless either the `--pending-deprecation` command line flag, or the
|
2017-03-11 21:18:53 +01:00
|
|
|
`NODE_PENDING_DEPRECATION=1` environment variable, is set. Pending deprecations
|
|
|
|
are used to provide a kind of selective "early warning" mechanism that
|
|
|
|
developers may leverage to detect deprecated API usage.
|
|
|
|
|
2019-03-13 14:10:54 +01:00
|
|
|
### `NODE_PENDING_PIPE_INSTANCES=instances`
|
|
|
|
|
|
|
|
Set the number of pending pipe instance handles when the pipe server is waiting
|
|
|
|
for connections. This setting applies to Windows only.
|
|
|
|
|
2016-09-21 00:21:44 +02:00
|
|
|
### `NODE_PRESERVE_SYMLINKS=1`
|
|
|
|
<!-- YAML
|
2016-11-03 12:00:09 +01:00
|
|
|
added: v7.1.0
|
2016-09-21 00:21:44 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
When set to `1`, instructs the module loader to preserve symbolic links when
|
|
|
|
resolving and caching modules.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `NODE_REDIRECT_WARNINGS=file`
|
2016-05-25 02:04:39 +02:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v8.0.0
|
2016-05-25 02:04:39 +02:00
|
|
|
-->
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
When set, process warnings will be emitted to the given file instead of
|
|
|
|
printing to stderr. The file will be created if it does not exist, and will be
|
|
|
|
appended to if it does. If an error occurs while attempting to write the
|
|
|
|
warning to the file, the warning will be written to stderr instead. This is
|
|
|
|
equivalent to using the `--redirect-warnings=file` command-line flag.
|
2016-03-18 18:26:41 +01:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
### `NODE_REPL_HISTORY=file`
|
2017-01-13 02:43:58 +01:00
|
|
|
<!-- YAML
|
2018-04-08 08:33:19 +02:00
|
|
|
added: v3.0.0
|
2017-01-13 02:43:58 +01:00
|
|
|
-->
|
2016-07-14 12:24:10 +02:00
|
|
|
|
2018-04-08 08:33:19 +02:00
|
|
|
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.
|
2016-10-17 20:56:58 +02:00
|
|
|
|
2019-09-27 00:58:49 +02:00
|
|
|
### `NODE_REPL_EXTERNAL_MODULE=file`
|
|
|
|
<!-- YAML
|
2020-04-24 18:43:06 +02:00
|
|
|
added:
|
|
|
|
- v13.0.0
|
|
|
|
- v12.16.0
|
2019-09-27 00:58:49 +02:00
|
|
|
-->
|
|
|
|
|
|
|
|
Path to a Node.js module which will be loaded in place of the built-in REPL.
|
|
|
|
Overriding this value to an empty string (`''`) will use the built-in REPL.
|
|
|
|
|
2020-04-30 21:19:52 +02:00
|
|
|
### `NODE_SKIP_PLATFORM_CHECK=value`
|
|
|
|
<!-- YAML
|
|
|
|
added: REPLACEME
|
|
|
|
-->
|
|
|
|
|
|
|
|
If `value` equals `'1'`, the check for a supported platform is skipped during
|
|
|
|
Node.js startup. Node.js might not execute correctly. Any issues encountered
|
|
|
|
on unsupported platforms will not be fixed.
|
|
|
|
|
2018-11-10 21:59:58 +01:00
|
|
|
### `NODE_TLS_REJECT_UNAUTHORIZED=value`
|
|
|
|
|
|
|
|
If `value` equals `'0'`, certificate validation is disabled for TLS connections.
|
|
|
|
This makes TLS, and HTTPS by extension, insecure. The use of this environment
|
|
|
|
variable is strongly discouraged.
|
|
|
|
|
2018-09-05 02:39:19 +02:00
|
|
|
### `NODE_V8_COVERAGE=dir`
|
|
|
|
|
2019-09-20 20:43:02 +02:00
|
|
|
When set, Node.js will begin outputting [V8 JavaScript code coverage][] and
|
|
|
|
[Source Map][] data to the directory provided as an argument (coverage
|
|
|
|
information is written as JSON to files with a `coverage` prefix).
|
|
|
|
|
|
|
|
`NODE_V8_COVERAGE` will automatically propagate to subprocesses, making it
|
|
|
|
easier to instrument applications that call the `child_process.spawn()` family
|
|
|
|
of functions. `NODE_V8_COVERAGE` can be set to an empty string, to prevent
|
|
|
|
propagation.
|
|
|
|
|
2020-06-14 23:49:34 +02:00
|
|
|
#### Coverage output
|
2019-09-20 20:43:02 +02:00
|
|
|
|
|
|
|
Coverage is output as an array of [ScriptCoverage][] objects on the top-level
|
|
|
|
key `result`:
|
2018-09-05 02:39:19 +02:00
|
|
|
|
|
|
|
```json
|
|
|
|
{
|
|
|
|
"result": [
|
|
|
|
{
|
|
|
|
"scriptId": "67",
|
|
|
|
"url": "internal/tty.js",
|
|
|
|
"functions": []
|
|
|
|
}
|
|
|
|
]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2020-06-14 23:49:34 +02:00
|
|
|
#### Source map cache
|
2019-09-20 20:43:02 +02:00
|
|
|
|
|
|
|
> Stability: 1 - Experimental
|
|
|
|
|
2020-06-14 23:49:34 +02:00
|
|
|
If found, source map data is appended to the top-level key `source-map-cache`
|
2019-09-20 20:43:02 +02:00
|
|
|
on the JSON coverage object.
|
|
|
|
|
|
|
|
`source-map-cache` is an object with keys representing the files source maps
|
2019-10-06 20:37:42 +02:00
|
|
|
were extracted from, and values which include the raw source-map URL
|
2020-06-14 23:49:34 +02:00
|
|
|
(in the key `url`), the parsed Source Map v3 information (in the key `data`),
|
2019-10-06 20:37:42 +02:00
|
|
|
and the line lengths of the source file (in the key `lineLengths`).
|
2018-09-05 02:39:19 +02:00
|
|
|
|
2019-09-20 20:43:02 +02:00
|
|
|
```json
|
|
|
|
{
|
|
|
|
"result": [
|
|
|
|
{
|
|
|
|
"scriptId": "68",
|
|
|
|
"url": "file:///absolute/path/to/source.js",
|
|
|
|
"functions": []
|
|
|
|
}
|
|
|
|
],
|
|
|
|
"source-map-cache": {
|
|
|
|
"file:///absolute/path/to/source.js": {
|
|
|
|
"url": "./path-to-map.json",
|
|
|
|
"data": {
|
|
|
|
"version": 3,
|
|
|
|
"sources": [
|
|
|
|
"file:///absolute/path/to/original.js"
|
|
|
|
],
|
|
|
|
"names": [
|
|
|
|
"Foo",
|
|
|
|
"console",
|
|
|
|
"info"
|
|
|
|
],
|
|
|
|
"mappings": "MAAMA,IACJC,YAAaC",
|
|
|
|
"sourceRoot": "./"
|
2019-10-06 20:37:42 +02:00
|
|
|
},
|
|
|
|
"lineLengths": [
|
|
|
|
13,
|
|
|
|
62,
|
|
|
|
38,
|
|
|
|
27
|
|
|
|
]
|
2019-09-20 20:43:02 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
```
|
2018-09-05 02:39:19 +02:00
|
|
|
|
2017-01-25 23:13:34 +01:00
|
|
|
### `OPENSSL_CONF=file`
|
|
|
|
<!-- YAML
|
2017-05-16 20:05:47 +02:00
|
|
|
added: v6.11.0
|
2017-01-25 23:13:34 +01:00
|
|
|
-->
|
|
|
|
|
|
|
|
Load an OpenSSL configuration file on startup. Among other uses, this can be
|
|
|
|
used to enable FIPS-compliant crypto if Node.js is built with `./configure
|
2017-06-20 03:23:09 +02:00
|
|
|
--openssl-fips`.
|
2017-01-25 23:13:34 +01:00
|
|
|
|
|
|
|
If the [`--openssl-config`][] command line option is used, the environment
|
|
|
|
variable is ignored.
|
|
|
|
|
2016-12-21 11:16:39 +01:00
|
|
|
### `SSL_CERT_DIR=dir`
|
2017-01-25 23:20:24 +01:00
|
|
|
<!-- YAML
|
2017-02-28 04:49:09 +01:00
|
|
|
added: v7.7.0
|
2017-01-25 23:20:24 +01:00
|
|
|
-->
|
2016-12-21 11:16:39 +01:00
|
|
|
|
|
|
|
If `--use-openssl-ca` is enabled, this overrides and sets OpenSSL's directory
|
|
|
|
containing trusted certificates.
|
|
|
|
|
2018-02-06 06:55:16 +01:00
|
|
|
Be aware that unless the child environment is explicitly set, this environment
|
|
|
|
variable will be inherited by any child processes, and if they use OpenSSL, it
|
|
|
|
may cause them to trust the same CAs as node.
|
2016-12-21 11:16:39 +01:00
|
|
|
|
|
|
|
### `SSL_CERT_FILE=file`
|
2017-01-25 23:20:24 +01:00
|
|
|
<!-- YAML
|
2017-02-28 04:49:09 +01:00
|
|
|
added: v7.7.0
|
2017-01-25 23:20:24 +01:00
|
|
|
-->
|
2016-12-21 11:16:39 +01:00
|
|
|
|
|
|
|
If `--use-openssl-ca` is enabled, this overrides and sets OpenSSL's file
|
|
|
|
containing trusted certificates.
|
|
|
|
|
2018-02-06 06:55:16 +01:00
|
|
|
Be aware that unless the child environment is explicitly set, this environment
|
|
|
|
variable will be inherited by any child processes, and if they use OpenSSL, it
|
|
|
|
may cause them to trust the same CAs as node.
|
2016-12-21 11:16:39 +01:00
|
|
|
|
2017-08-23 23:59:06 +02:00
|
|
|
### `UV_THREADPOOL_SIZE=size`
|
|
|
|
|
|
|
|
Set the number of threads used in libuv's threadpool to `size` threads.
|
|
|
|
|
|
|
|
Asynchronous system APIs are used by Node.js whenever possible, but where they
|
|
|
|
do not exist, libuv's threadpool is used to create asynchronous node APIs based
|
|
|
|
on synchronous system APIs. Node.js APIs that use the threadpool are:
|
|
|
|
|
2019-09-13 06:22:29 +02:00
|
|
|
* all `fs` APIs, other than the file watcher APIs and those that are explicitly
|
2017-08-23 23:59:06 +02:00
|
|
|
synchronous
|
2019-09-13 06:22:29 +02:00
|
|
|
* asynchronous crypto APIs such as `crypto.pbkdf2()`, `crypto.scrypt()`,
|
2019-08-07 13:26:00 +02:00
|
|
|
`crypto.randomBytes()`, `crypto.randomFill()`, `crypto.generateKeyPair()`
|
2019-09-13 06:22:29 +02:00
|
|
|
* `dns.lookup()`
|
|
|
|
* all `zlib` APIs, other than those that are explicitly synchronous
|
2017-08-23 23:59:06 +02:00
|
|
|
|
|
|
|
Because libuv's threadpool has a fixed size, it means that if for whatever
|
|
|
|
reason any of these APIs takes a long time, other (seemingly unrelated) APIs
|
|
|
|
that run in libuv's threadpool will experience degraded performance. In order to
|
|
|
|
mitigate this issue, one potential solution is to increase the size of libuv's
|
|
|
|
threadpool by setting the `'UV_THREADPOOL_SIZE'` environment variable to a value
|
2018-04-02 07:38:48 +02:00
|
|
|
greater than `4` (its current default value). For more information, see the
|
2017-08-23 23:59:06 +02:00
|
|
|
[libuv threadpool documentation][].
|
|
|
|
|
2020-03-14 17:30:07 +01:00
|
|
|
## Useful V8 options
|
|
|
|
|
|
|
|
V8 has its own set of CLI options. Any V8 CLI option that is provided to `node`
|
|
|
|
will be passed on to V8 to handle. V8's options have _no stability guarantee_.
|
|
|
|
The V8 team themselves don't consider them to be part of their formal API,
|
|
|
|
and reserve the right to change them at any time. Likewise, they are not
|
|
|
|
covered by the Node.js stability guarantees. Many of the V8
|
|
|
|
options are of interest only to V8 developers. Despite this, there is a small
|
|
|
|
set of V8 options that are widely applicable to Node.js, and they are
|
|
|
|
documented here:
|
|
|
|
|
2020-06-14 23:49:34 +02:00
|
|
|
### `--max-old-space-size=SIZE` (in megabytes)
|
2020-03-14 17:30:07 +01:00
|
|
|
|
|
|
|
Sets the max memory size of V8's old memory section. As memory
|
|
|
|
consumption approaches the limit, V8 will spend more time on
|
|
|
|
garbage collection in an effort to free unused memory.
|
|
|
|
|
|
|
|
On a machine with 2GB of memory, consider setting this to
|
|
|
|
1536 (1.5GB) to leave some memory for other uses and avoid swapping.
|
|
|
|
|
|
|
|
```console
|
|
|
|
$ node --max-old-space-size=1536 index.js
|
|
|
|
```
|
|
|
|
|
2017-05-08 18:30:13 +02:00
|
|
|
[`--openssl-config`]: #cli_openssl_config_file
|
2019-12-06 00:39:16 +01:00
|
|
|
[`Atomics.wait()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Atomics/wait
|
2018-04-16 23:59:39 +02:00
|
|
|
[`Buffer`]: buffer.html#buffer_class_buffer
|
|
|
|
[`SlowBuffer`]: buffer.html#buffer_class_slowbuffer
|
|
|
|
[`process.setUncaughtExceptionCaptureCallback()`]: process.html#process_process_setuncaughtexceptioncapturecallback_fn
|
2019-03-07 23:51:33 +01:00
|
|
|
[`tls.DEFAULT_MAX_VERSION`]: tls.html#tls_tls_default_max_version
|
|
|
|
[`tls.DEFAULT_MIN_VERSION`]: tls.html#tls_tls_default_min_version
|
2019-03-11 20:46:43 +01:00
|
|
|
[`unhandledRejection`]: process.html#process_event_unhandledrejection
|
2019-12-06 00:39:16 +01:00
|
|
|
[`worker_threads.threadId`]: worker_threads.html##worker_threads_worker_threadid
|
2018-04-17 19:04:03 +02:00
|
|
|
[Chrome DevTools Protocol]: https://chromedevtools.github.io/devtools-protocol/
|
2016-03-18 18:26:41 +01:00
|
|
|
[REPL]: repl.html
|
2018-09-05 02:39:19 +02:00
|
|
|
[ScriptCoverage]: https://chromedevtools.github.io/devtools-protocol/tot/Profiler#type-ScriptCoverage
|
2019-09-20 20:43:02 +02:00
|
|
|
[Source Map]: https://sourcemaps.info/spec.html
|
2019-06-05 20:33:07 +02:00
|
|
|
[Subresource Integrity]: https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity
|
2018-09-05 02:39:19 +02:00
|
|
|
[V8 JavaScript code coverage]: https://v8project.blogspot.com/2017/12/javascript-code-coverage.html
|
2019-11-09 13:03:49 +01:00
|
|
|
[context-aware]: addons.html#addons_context_aware_addons
|
|
|
|
[customizing ESM specifier resolution]: esm.html#esm_customizing_esm_specifier_resolution_algorithm
|
2017-05-08 18:30:13 +02:00
|
|
|
[debugger]: debugger.html
|
2018-10-13 18:40:44 +02:00
|
|
|
[debugging security implications]: https://nodejs.org/en/docs/guides/debugging-getting-started/#security-implications
|
2017-06-20 08:04:24 +02:00
|
|
|
[emit_warning]: process.html#process_process_emitwarning_warning_type_code_ctor
|
2019-12-15 04:27:48 +01:00
|
|
|
[experimental ECMAScript Module loader]: esm.html#esm_experimental_loaders
|
2020-03-05 00:34:28 +01:00
|
|
|
[jitless]: https://v8.dev/blog/jitless
|
2017-08-23 23:59:06 +02:00
|
|
|
[libuv threadpool documentation]: http://docs.libuv.org/en/latest/threadpool.html
|
2018-10-13 18:40:44 +02:00
|
|
|
[remote code execution]: https://www.owasp.org/index.php/Code_Injection
|