Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, February 9, 2022

node (1)


node - side JavaScript runtime


node [options] [v8-options] [-e string | script.js | -] [--]
[arguments ...]
node inspect [-e string | script.js | - | <host>:<port>] ...
node [--v8-options]


NODE(1)                   BSD General Commands Manual                  NODE(1)

     node -- server-side JavaScript runtime

     node [options] [v8-options] [-e string | script.js | -] [--]
          [arguments ...]
     node inspect [-e string | script.js | - | <host>:<port>] ...
     node [--v8-options]

     Node.js is a set of libraries for JavaScript which allows it to be used
     outside of the browser.  It is primarily focused on creating simple,
     easy-to-build network clients and servers.

     Execute node without arguments to start a REPL.

     -       Alias for stdin, analogous to the use of - in other command-line
             utilities.  The executed script is read from stdin, and remaining
             arguments are passed to the script.

     --      Indicate the end of command-line 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.

             Aborting instead of exiting causes a core file to be generated
             for analysis.

             Print source-able bash completion script for Node.js.

     -C, --conditions string
             Use custom conditional exports conditions.  string

             Start the V8 CPU profiler on start up, and write the CPU profile
             to disk before exit. If --cpu-prof-dir is not specified, the pro-
             file will be written to the current working directory with a gen-
             erated file name.

             The directory where the CPU profiles generated by --cpu-prof will
             be placed.  The default value is controlled by the
             --diagnostic-dir.  command-line option.

             The sampling interval in microseconds for the CPU profiles gener-
             ated by --cpu-prof.  The default is 1000.

             File name of the V8 CPU profile generated with --cpu-prof.

             Set the directory for all diagnostic output files.  Default is
             current working directory.  Set the directory to which all diag-
             nostic output files will be written to.  Defaults to current
             working directory.  Affects the default output directory of:
             --cpu-prof-dir.  --heap-prof-dir.  --redirect-warnings.

             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`.

             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.

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

             Enable Source Map V3 support for stack traces.

             Enable experimental ES modules support for import.meta.resolve().

             Enable experimental JSON interop support for the ES Module

             Specify the module to use as a custom module loader.

             Use the specified file as a security policy.

             Disable top-level await keyword support in REPL.

             Select extension resolution algorithm for ES Modules; either
             'explicit' (default) or 'node'.

             Enable experimental ES module support in VM module.

             Enable experimental WebAssembly System Interface support.

             Enable experimental WebAssembly module support.

             Disable loading native addons that are not context-aware.

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

             Enable experimental frozen intrinsics support.

             Generate heap snapshot when the V8 heap usage is approaching the
             heap limit.  No more than the specified number of snapshots will
             be generated.

             Generate heap snapshot on specified signal.

             Start the V8 heap profiler on start up, and write the heap pro-
             file to disk before exit. If --heap-prof-dir is not specified,
             the profile will be written to the current working directory with
             a generated file name.

             The directory where the heap profiles generated by --heap-prof
             will be placed.  The default value is controlled by the
             --diagnostic-dir.  command-line option.

             The average sampling interval in bytes for the heap profiles gen-
             erated by --heap-prof.  The default is 512 * 1024.

             File name of the V8 heap profile generated with --heap-prof.

             Specify ICU data load path.  Overrides NODE_ICU_DATA.

             Set the module resolution type for input via --eval, --print or

             Activate inspector on host:port and break at start of user

             Set the host:port to be used when the inspector is activated.

             Specify how the inspector WebSocket URL is exposed.  Valid values
             are stderr and http.  Default is stderr,http.

             Activate inspector on host:port.  Default is

             V8 Inspector integration allows attaching Chrome DevTools and
             IDEs to Node.js instances for debugging and profiling.  It uses
             the Chrome DevTools Protocol.

             Use an insecure HTTP parser that accepts invalid HTTP headers.
             This may allow interoperability with non-conformant HTTP imple-
             mentations. It may also allow request smuggling and other HTTP
             attacks that rely on invalid headers being accepted. Avoid using
             this option.

             Disable runtime allocation of executable memory. 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.

             Specify the maximum size of HTTP headers in bytes. Defaults to 16

             This option is a no-op.  It is kept for compatibility.

             Silence deprecation warnings.

             Disable runtime checks for `async_hooks`.  These will still be
             enabled dynamically when `async_hooks` is enabled.

             Disable the `node-addons` exports condition as well as disable
             loading native addons. When `--no-addons` is specified, calling
             `process.dlopen` or requiring a native C++ addon will fail and
             throw an exception.

             Do not search modules from global paths.

             Silence all process warnings (including deprecations).

             Enable extra debug checks for memory leaks in Node.js internals.
             This is usually only useful for developers debugging Node.js

             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.

             Emit pending deprecation warnings.

             Instructs Node.js to error prior to running any code if the pol-
             icy does not have the specified integrity. It expects a Subre-
             source Integrity string as a parameter.

             Instructs the module loader to preserve symbolic links when
             resolving and caching modules other than the main module.

             Instructs the module loader to preserve symbolic links when
             resolving and caching the main module.

     --prof  Generate V8 profiler output.

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

             Write process warnings to the given file instead of printing to

             Write diagnostic reports in a compact format, single-line JSON.

     --report-dir --report-directory
             Location at which the diagnostic report will be generated.  The
             `file` name may be an absolute path. If it is not, the default
             directory it will be written to is controlled by the
             --diagnostic-dir.  command-line option.

             Name of the file to which the diagnostic report will be written.

             Enables the diagnostic report to be triggered on fatal errors
             (internal errors within the Node.js runtime such as out of mem-
             ory) that leads to termination of the application. Useful to
             inspect various diagnostic data elements such as heap, stack,
             event loop state, resource consumption etc. to reason about the
             fatal error.

             Enables diagnostic report to be generated upon receiving the
             specified (or predefined) signal to the running Node.js process.
             Default signal is SIGUSR2.

             Sets or resets the signal for diagnostic report generation (not
             supported on Windows). Default signal is SIGUSR2.

             Enables diagnostic report to be generated on un-caught excep-
             tions. Useful when inspecting JavaScript stack in conjunction
             with native stack and other runtime environment data.

             Specify the size of the OpenSSL secure heap. Any value less than
             2 disables the secure heap. The default is 0. The value must be a
             power of two.

             Specify the minimum allocation from the OpenSSL secure heap. The
             default is 2. The value must be a power of two.

             Throw errors for deprecations.

             Specify process.title on startup.

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

             Log TLS key material to a file. The key material is in NSS
             SSLKEYLOGFILE format and can be used by software (such as Wire-
             shark) to decrypt the TLS traffic.

             Set default  maxVersion to 'TLSv1.2'. Use to disable support for

             Set default  maxVersion to 'TLSv1.3'. Use to enable support for

             Set default minVersion to 'TLSv1'. Use for compatibility with old
             TLS clients or servers.

             Set default minVersion to 'TLSv1.1'. Use for compatibility with
             old TLS clients or servers.

             Set default minVersion to 'TLSv1.2'. This is the default for 12.x
             and later, but the option is supported for compatibility with
             older Node.js versions.

             Set default minVersion to 'TLSv1.3'. Use to disable support for
             TLSv1.2 in favour of TLSv1.3, which is more secure.

             Print short summaries of calls to Atomics.wait().

             Print stack traces for deprecations.

     --trace-event-categories categories
             A comma-separated list of categories that should be traced when
             trace event tracing is enabled using --trace-events-enabled.

     --trace-event-file-pattern pattern
             Template string specifying the filepath for the trace event data,
             it supports ${rotation} and ${pid}.

             Enable the collection of trace event tracing information.

             Prints a stack trace whenever an environment is exited proac-
             tively, i.e. invoking `process.exit()`.

             Prints a stack trace on SIGINT.

             Print a stack trace whenever synchronous I/O is detected after
             the first turn of the event loop.

             Prints TLS packet trace information to stderr.

             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

             Enabling this option may affect garbage collection behavior nega-

             Print stack traces for process warnings (including deprecations).

             Track heap object allocations for heap snapshots.

             Define the behavior for unhandled rejections. Can be one of
             `strict` (raise an error), `warn` (enforce warnings) or `none`
             (silence warnings).

     --use-bundled-ca, --use-openssl-ca
             Use bundled Mozilla CA store as supplied by current Node.js ver-
             sion 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 main-
             tained 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 environ-
             ment variables.

             See SSL_CERT_DIR and SSL_CERT_FILE.

             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.

             mode must have one of the following values: `off` (the default
             value, meaning do not map), `on` (map and ignore failure, report-
             ing it to stderr), or `silent` (map and silently ignore failure).

             Print V8 command-line options.

             Set V8's thread pool size which will be used to allocate back-
             ground jobs.  If set to 0 then V8 will choose an appropriate size
             of the thread pool based on the number of online processors.  If
             the value provided is larger than V8's maximum, then the largest
             value will be chosen.

             Automatically zero-fills all newly allocated Buffer and Slow-
             Buffer instances.

     -c, --check
             Check the script's syntax without executing it.  Exits with an
             error code if script is invalid.

     -e, --eval string
             Evaluate string as JavaScript.

     -h, --help
             Print command-line options.  The output of this option is less
             detailed than this document.

     -i, --interactive
             Open the REPL even if stdin does not appear to be a terminal.

     -p, --print string
             Identical to -e, but prints the result.

     -r, --require module
             Preload the specified module at startup.  Follows `require()`'s
             module resolution rules.  module may be either a path to a file,
             or a Node.js module name.

     -v, --version
             Print node's version.

             Used to enable ANSI colorized output. The value may be one of: 1
             , true , or an empty string to indicate 16-color support, 2 to
             indicate 256-color support, or 3 to indicate 16 million-color
             support. When used and set to a supported value, both the
             NO_COLOR and NODE_DISABLE_COLORS environment variables are
             ignored. Any other value will result in colorized output being

             Alias for NODE_DISABLE_COLORS

     NODE_DEBUG modules...
             Comma-separated list of core modules that should print debug

     NODE_DEBUG_NATIVE modules...
             Comma-separated list of C++ core modules that should print debug

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

             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.

             If file is missing or misformatted, a message will be emitted
             once using process.emitWarning(), but any errors are otherwise

             This environment variable is ignored when `node` runs as setuid
             root or has Linux file capabilities set.

             The NODE_EXTRA_CA_CERTS environment variable is only read when
             the Node.js process is first launched.  Changing the value at
             runtime using process.env.NODE_EXTRA_CA_CERTS has no effect on
             the current process.

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

             When set to 1, process warnings are silenced.

     NODE_OPTIONS options...
             A space-separated list of command-line options, which are inter-
             preted as if they had been specified on the command line before
             the actual command (so they can be overridden).  Node.js will
             exit with an error if an option that is not allowed in the envi-
             ronment is used, such as --print or a script file.

     NODE_PATH directories...
             A colon-separated list of directories prefixed to the module
             search path.

             When set to 1, emit pending deprecation warnings.

             When set to 1, the module loader preserves symbolic links when
             resolving and caching modules.

             Write process warnings to the given file instead of printing to
             stderr.  Equivalent to passing --redirect-warnings file on the
             command line.

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

             When set to 1, the check for a supported platform is skipped dur-
             ing Node.js startup.  Node.js might not execute correctly.  Any
             issues encountered on unsupported platforms will not be fixed.

             When set to 0, TLS certificate validation is disabled.

             When set, Node.js writes JavaScript code coverage information to

     OPENSSL_CONF file
             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.

             If the --openssl-config command-line option is used, this envi-
             ronment variable is ignored.

     SSL_CERT_DIR dir
             If --use-openssl-ca is enabled, this overrides and sets OpenSSL's
             directory containing trusted certificates.

     SSL_CERT_FILE file
             If --use-openssl-ca is enabled, this overrides and sets OpenSSL's
             file containing trusted certificates.

             Sets the number of threads used in libuv's threadpool to size.

     Bugs are tracked in GitHub Issues: https://github.com/nodejs/node/issues

     Copyright Node.js contributors.  Node.js is available under the MIT

     Node.js also includes external libraries that are available under a vari-
     ety of licenses.  See https://github.com/nodejs/node/blob/HEAD/LICENSE
     for the full license text.

     See attributes(7) for descriptions of the following attributes:

     |Availability   | runtime/nodejs/nodejs-16 |
     |Stability      | Pass-thru volatile       |

     Website: https://nodejs.org/

     Documentation: https://nodejs.org/api/

     GitHub repository and issue tracker: https://github.com/nodejs/node

     IRC (general questions): libera.chat #node.js (unofficial)

     Written and maintained by 1000+ contributors:

     Source code for open source software components in Oracle Solaris can be
     found at https://www.oracle.com/downloads/opensource/solaris-source-code-

     This software was built from source available at https://github.com/ora-
     cle/solaris-userland.  The original community source was downloaded from

     Further information about this software can be found on the open source
     community website at https://github.com/nodejs/node.

                               February 9, 2022