Usage: node [options] [ script.js ] [arguments]
node inspect [options] [ script.js | host:port ] [arguments]
Options:
- script read from stdin (default if no
file name is provided, interactive mode
if a tty)
-- indicate the end of node options
--abort-on-uncaught-exception
aborting instead of exiting causes a
core file to be generated for analysis
--build-snapshot Generate a snapshot blob when the
process exits. Currently only supported
in the node_mksnapshot binary.
-c, --check syntax check script without executing
--completion-bash print source-able bash completion
script
-C, --conditions=... additional user conditions for
conditional exports and imports
--cpu-prof Start the V8 CPU profiler on start up,
and write the CPU profile to disk
before exit. If --cpu-prof-dir is not
specified, write the profile to the
current working directory.
--cpu-prof-dir=... Directory where the V8 profiles
generated by --cpu-prof will be placed.
Does not affect --prof.
--cpu-prof-interval=... specified sampling interval in
microseconds for the V8 CPU profile
generated with --cpu-prof. (default:
1000)
--cpu-prof-name=... specified file name of the V8 CPU
profile generated with --cpu-prof
--diagnostic-dir=... set dir for all output files (default:
current working directory)
--disable-proto=... disable Object.prototype.__proto__
--disallow-code-generation-from-strings
disallow eval and friends
--dns-result-order=... set default value of verbatim in
dns.lookup. Options are 'ipv4first'
(IPv4 addresses are placed before IPv6
addresses) 'verbatim' (addresses are in
the order the DNS resolver returned)
--enable-etw-stack-walking provides heap data to ETW Windows
native tracing
--enable-fips enable FIPS crypto at startup
--enable-network-family-autoselection
Enable network address family
autodetection algorithm
--enable-source-maps Source Map V3 support for stack traces
-e, --eval=... evaluate script
--experimental-default-type=...
set module system to use by default
--experimental-global-customevent
expose experimental CustomEvent on the
global scope
--experimental-global-webcrypto
expose experimental Web Crypto API on
the global scope
--experimental-import-meta-resolve
experimental ES Module
import.meta.resolve() parentURL support
--loader, --experimental-loader=...
use the specified module as a custom
loader
--experimental-network-imports
experimental https: support for the ES
Module loader
--experimental-policy=... use the specified file as a security
policy
--es-module-specifier-resolution, --experimental-specifier-resolution=...
Select extension resolution algorithm
for es modules; either 'explicit'
(default) or 'node'
--experimental-test-coverage
enable code coverage in the test runner
--experimental-vm-modules experimental ES Module support in vm
module
--experimental-wasm-modules experimental ES Module support for
webassembly modules
--force-context-aware disable loading non-context-aware
addons
--force-fips force FIPS crypto (cannot be disabled)
--force-node-api-uncaught-exceptions-policy
enforces 'uncaughtException' event on
Node API asynchronous callbacks
--frozen-intrinsics experimental frozen intrinsics support
--heap-prof Start the V8 heap profiler on start up,
and write the heap profile to disk
before exit. If --heap-prof-dir is not
specified, write the profile to the
current working directory.
--heap-prof-dir=... Directory where the V8 heap profiles
generated by --heap-prof will be
placed.
--heap-prof-interval=... specified sampling interval in bytes
for the V8 heap profile generated with
--heap-prof. (default: 512 * 1024)
--heap-prof-name=... specified file name of the V8 heap
profile generated with --heap-prof
--heapsnapshot-near-heap-limit=...
Generate heap snapshots whenever V8 is
approaching the heap limit. No more
than the specified number of heap
snapshots will be generated.
--heapsnapshot-signal=... Generate heap snapshot on specified
signal
-h, --help print node command line options
(currently set)
--huge-max-old-generation-size
increase default maximum heap size on
machines with 16GB memory or more
--icu-data-dir=... set ICU data load path to dir
(overrides NODE_ICU_DATA) (note:
linked-in ICU data is present)
--import=... ES module to preload (option can be
repeated)
--input-type=... set module type for string input
--insecure-http-parser use an insecure HTTP parser that
accepts invalid HTTP headers
--inspect[=[host:]port] activate inspector on host:port
(default: 127.0.0.1:9229)
--inspect-brk[=[host:]port] activate inspector on host:port and
break at start of user script
--debug-port, --inspect-port=[host:]port
set host:port for inspector
--inspect-publish-uid=... comma separated list of destinations
for inspector uid(default: stderr,http)
-i, --interactive always enter the REPL even if stdin
does not appear to be a terminal
--interpreted-frames-native-stack
help system profilers to translate
JavaScript interpreted frames
--jitless disable runtime allocation of
executable memory
--max-http-header-size=... set the maximum size of HTTP headers
(default: 16384 (16KB))
--no-addons disable loading native addons
--no-deprecation silence deprecation warnings
--no-experimental-fetch experimental Fetch API
--no-experimental-repl-await
experimental await keyword support in
REPL
--no-extra-info-on-fatal-exception
hide extra information on fatal
exception that causes exit
--no-force-async-hooks-checks
disable checks for async_hooks
--no-global-search-paths disable global module search paths
--no-warnings silence all process warnings
--node-memory-debug Run with extra debug checks for memory
leaks in Node.js itself
--openssl-config=... load OpenSSL configuration from the
specified file (overrides OPENSSL_CONF)
--openssl-legacy-provider enable OpenSSL 3.0 legacy provider
--openssl-shared-config enable OpenSSL shared configuration
--pending-deprecation emit pending deprecation warnings
--policy-integrity=... ensure the security policy contents
match the specified integrity
--preserve-symlinks preserve symbolic links when resolving
--preserve-symlinks-main preserve symbolic links when resolving
the main module
-p, --print [...] evaluate script and print result
--prof Generate V8 profiler output.
--prof-process process V8 profiler output generated
using --prof
--redirect-warnings=... write warnings to file instead of
stderr
--report-compact output compact single-line JSON
--report-directory, --report-dir=...
define custom report pathname.
(default: current working directory)
--report-filename=... define custom report file name.
(default:
YYYYMMDD.HHMMSS.PID.SEQUENCE#.txt)
--report-on-fatalerror generate diagnostic report on fatal
(internal) errors
--report-on-signal generate diagnostic report upon
receiving signals
--report-signal=... causes diagnostic report to be produced
on provided signal, unsupported in
Windows. (default: SIGUSR2)
--report-uncaught-exception generate diagnostic report on uncaught
exceptions
-r, --require=... CommonJS module to preload (option can
be repeated)
--secure-heap=... total size of the OpenSSL secure heap
--secure-heap-min=... minimum allocation size from the
OpenSSL secure heap
--snapshot-blob=... Path to the snapshot blob that's either
the result of snapshotbuilding, or the
blob that is used to restore the
application state
--test launch test runner on startup
--test-concurrency=... specify test runner concurrency
--test-name-pattern=... run tests whose name matches this
regular expression
--test-only run tests with 'only' option set
--test-reporter=... report test output using the given
reporter
--test-reporter-destination=...
report given reporter to the given
destination
--test-shard=... run test at specific shard
--throw-deprecation throw an exception on deprecations
--title=... the process title to use on startup
--tls-cipher-list=... use an alternative default TLS cipher
list
--tls-keylog=... log TLS decryption keys to named file
for traffic analysis
--tls-max-v1.2 set default TLS maximum to TLSv1.2
(default: TLSv1.3)
--tls-max-v1.3 set default TLS maximum to TLSv1.3
(default: TLSv1.3)
--tls-min-v1.0 set default TLS minimum to TLSv1.0
(default: TLSv1.2)
--tls-min-v1.1 set default TLS minimum to TLSv1.1
(default: TLSv1.2)
--tls-min-v1.2 set default TLS minimum to TLSv1.2
(default: TLSv1.2)
--tls-min-v1.3 set default TLS minimum to TLSv1.3
(default: TLSv1.2)
--trace-atomics-wait (deprecated) trace Atomics.wait()
operations
--trace-deprecation show stack traces on deprecations
--trace-event-categories=...
comma separated list of trace event
categories to record
--trace-event-file-pattern=...
Template string specifying the filepath
for the trace-events data, it supports
${rotation} and ${pid}.
--trace-exit show stack trace when an environment
exits
--trace-sigint enable printing JavaScript stacktrace
on SIGINT
--trace-sync-io show stack trace when use of sync IO is
detected after the first tick
--trace-tls prints TLS packet trace information to
stderr
--trace-uncaught show stack traces for the `throw`
behind uncaught exceptions
--trace-warnings show stack traces on process warnings
--track-heap-objects track heap object allocations for heap
snapshots
--unhandled-rejections=... define unhandled rejections behavior.
Options are 'strict' (always raise an
error), 'throw' (raise an error unless
'unhandledRejection' hook is set),
'warn' (log a warning), 'none' (silence
warnings), 'warn-with-error-code' (log
a warning and set exit code 1 unless
'unhandledRejection' hook is set).
(default: throw)
--use-bundled-ca use bundled CA store
--use-largepages=... Map the Node.js static code to large
pages. Options are 'off' (the default
value, meaning do not map), 'on' (map
and ignore failure, reporting it to
stderr), or 'silent' (map and silently
ignore failure)
--use-openssl-ca use OpenSSL's default CA store
(default)
--v8-options print V8 command line options
--v8-pool-size=... set V8's thread pool size
-v, --version print Node.js version
--watch run in watch mode
--watch-path=... path to watch
--watch-preserve-output preserve outputs on watch mode restart
--zero-fill-buffers automatically zero-fill all newly
allocated Buffer and SlowBuffer
instances
Environment variables:
FORCE_COLOR when set to 'true', 1, 2, 3, or an
empty string causes NO_COLOR and
NODE_DISABLE_COLORS to be ignored.
NO_COLOR Alias for NODE_DISABLE_COLORS
NODE_DEBUG ','-separated list of core modules that
should print debug information
NODE_DEBUG_NATIVE ','-separated list of C++ core debug
categories that should print debug
output
NODE_DISABLE_COLORS set to 1 to disable colors in the REPL
NODE_EXTRA_CA_CERTS path to additional CA certificates
file. Only read once during process
startup.
NODE_NO_WARNINGS set to 1 to silence process warnings
NODE_PATH ':'-separated list of directories
prefixed to the module search path
NODE_PENDING_DEPRECATION set to 1 to emit pending deprecation
warnings
NODE_PENDING_PIPE_INSTANCES set the number of pending pipe instance
handles on Windows
NODE_PRESERVE_SYMLINKS set to 1 to preserve symbolic links
when resolving and caching modules
NODE_REDIRECT_WARNINGS write warnings to path instead of
stderr
NODE_REPL_EXTERNAL_MODULE path to a Node.js module which will be
loaded in place of the built-in REPL
NODE_REPL_HISTORY path to the persistent REPL history
file
NODE_SKIP_PLATFORM_CHECK set to 1 to skip the check for a
supported platform during Node.js
startup
NODE_TLS_REJECT_UNAUTHORIZED
set to 0 to disable TLS certificate
validation
NODE_V8_COVERAGE directory to output v8 coverage JSON to
TZ specify the timezone configuration
UV_THREADPOOL_SIZE sets the number of threads used in
libuv's threadpool
Documentation can be found at https://nodejs.org/
Options (127)
| Option | Description | Source |
|---|---|---|
--abort-on-uncaught-exception | Aborting instead of exiting causes a core file to be generated for analysis. | help + man |
--build-snapshot | Generate a snapshot blob when the process exits. | help |
-c, --check | Check the script's syntax without executing it. | help + man |
--completion-bash | Print source-able bash completion script for Node.js. | help + man |
-C, --conditions ... | additional user conditions for conditional exports and imports | help + man |
--cpu-prof | Start the V8 CPU profiler on start up, and write the CPU profile to disk before exit. | help + man |
--cpu-prof-dir ... | The directory where the CPU profiles generated by --cpu-prof will be placed. | help + man |
--cpu-prof-interval ... | specified sampling interval in microseconds for the V8 CPU profile generated with --cpu-prof. | help + man |
--cpu-prof-name ... | specified file name of the V8 CPU profile generated with --cpu-prof | help + man |
--diagnostic-dir ... | set dir for all output files (default: current working directory) | help + man |
--disable-proto ... | Disable the Object.prototype.__proto__ property. | help + man |
--disallow-code-generation-from-strings | Make built-in language features like eval and new Function that generate code from strings throw an exception instead. | help + man |
--dns-result-order ... | set default value of verbatim in dns.lookup. | help |
--enable-etw-stack-walking | provides heap data to ETW Windows native tracing | help |
--enable-fips | Enable FIPS-compliant crypto at startup. | help + man |
--enable-network-family-autoselection | Enable network address family autodetection algorithm | help |
--enable-source-maps | Enable Source Map V3 support for stack traces. | help + man |
-e, --eval ... | Evaluate string as JavaScript. | help + man |
--experimental-default-type ... | Interpret as either ES modules or CommonJS modules input via --eval or STDIN, when --input-type is unspecified; | help + man |
--experimental-global-customevent | expose experimental CustomEvent on the global scope | help + man |
--experimental-global-webcrypto | expose experimental Web Crypto API on the global scope | help + man |
--experimental-import-meta-resolve | Enable experimental ES modules support for import.meta.resolve(). | help + man |
--loader, --experimental-loader ... | Specify the module to use as a custom module loader. | help + man |
--experimental-network-imports | Enable experimental support for loading modules using import over https:. | help + man |
--experimental-policy ... | Use the specified file as a security policy. | help + man |
--es-module-specifier-resolution, --experimental-specifier-resolution ... | Select extension resolution algorithm for es modules; | help + man |
--experimental-test-coverage | Enable code coverage in the test runner. | help + man |
--experimental-vm-modules | Enable experimental ES module support in VM module. | help + man |
--force-context-aware | Disable loading native addons that are not context-aware. | help + man |
--force-fips | Force FIPS-compliant crypto on startup (Cannot be disabled from script code). | help + man |
--force-node-api-uncaught-exceptions-policy | enforces 'uncaughtException' event on Node API asynchronous callbacks | help |
--frozen-intrinsics | Enable experimental frozen intrinsics support. | help + man |
--heap-prof | Start the V8 heap profiler on start up, and write the heap profile to disk before exit. | help + man |
--heap-prof-dir ... | The directory where the heap profiles generated by --heap-prof will be placed. | help + man |
--heap-prof-interval ... | The average sampling interval in bytes for the heap profiles generated by --heap-prof. | help + man |
--heap-prof-name ... | specified file name of the V8 heap profile generated with --heap-prof | help + man |
--heapsnapshot-near-heap-limit ... | Generate heap snapshot when the V8 heap usage is approaching the heap limit. | help + man |
--heapsnapshot-signal ... | Generate heap snapshot on specified signal. | help + man |
-h, --help | print node command line options (currently set) | help + man |
--huge-max-old-generation-size | increase default maximum heap size on machines with 16GB memory or more | help |
--icu-data-dir ... | set ICU data load path to dir (overrides NODE_ICU_DATA) (note: linked-in ICU data is present) | help + man |
--import ... | ES module to preload (option can be repeated) | help |
--input-type ... | Set the module resolution type for input via --eval, --print or STDIN. | help + man |
--insecure-http-parser | Use an insecure HTTP parser that accepts invalid HTTP headers. | help + man |
--inspect host:]port | activate inspector on host:port (default: 127.0.0.1:9229) | help + man |
--debug-port, --inspect-port host:]port | Set the host:port to be used when the inspector is activated. | help + man |
--inspect-publish-uid ... | comma separated list of destinations for inspector uid(default: stderr,http) | help + man |
-i, --interactive | always enter the REPL even if stdin does not appear to be a terminal | help + man |
--interpreted-frames-native-stack | help system profilers to translate JavaScript interpreted frames | help |
--jitless | Disable runtime allocation of executable memory. | help + man |
--max-http-header-size ... | set the maximum size of HTTP headers (default: 16384 (16KB)) | help + man |
--no-addons | Disable the node-addons exports condition as well as disable loading native addons. | help + man |
--no-deprecation | Silence deprecation warnings. | help + man |
--no-experimental-fetch | Disable experimental support for the Fetch API. | help + man |
--no-experimental-repl-await | Disable top-level await keyword support in REPL. | help + man |
--no-extra-info-on-fatal-exception | Hide extra information on fatal exception that causes exit. | help + man |
--no-force-async-hooks-checks | Disable runtime checks for async_hooks. | help + man |
--no-global-search-paths | Do not search modules from global paths. | help + man |
--no-warnings | Silence all process warnings (including deprecations). | help + man |
--node-memory-debug | Enable extra debug checks for memory leaks in Node.js internals. | help + man |
--openssl-config ... | load OpenSSL configuration from the specified file (overrides OPENSSL_CONF) | help + man |
--openssl-legacy-provider | enable OpenSSL 3.0 legacy provider | help |
--openssl-shared-config | enable OpenSSL shared configuration | help |
--pending-deprecation | Emit pending deprecation warnings. | help + man |
--policy-integrity ... | Instructs Node.js to error prior to running any code if the policy does not have the specified integrity. | help + man |
--preserve-symlinks | Instructs the module loader to preserve symbolic links when resolving and caching modules other than the main module. | help + man |
--preserve-symlinks-main | Instructs the module loader to preserve symbolic links when resolving and caching the main module. | help + man |
-p, --print ... | Identical to -e, but prints the result. | help + man |
--prof | Generate V8 profiler output. | help + man |
--prof-process | Process V8 profiler output generated using the V8 option --prof. | help + man |
--redirect-warnings ... | Write process warnings to the given file instead of printing to stderr. | help + man |
--report-compact | Write diagnostic reports in a compact format, single-line JSON. | help + man |
--report-directory, --report-dir ... | Location at which the diagnostic report will be generated. | help + man |
--report-filename ... | Name of the file to which the diagnostic report will be written. | help + man |
--report-on-fatalerror | Enables the diagnostic report to be triggered on fatal errors (internal errors within the Node.js runtime such as out of memory) that leads to termination of the application. | help + man |
--report-on-signal | Enables diagnostic report to be generated upon receiving the specified (or predefined) signal to the running Node.js process. | help + man |
--report-signal ... | Sets or resets the signal for diagnostic report generation (not supported on Windows). | help + man |
-r, --require ... | CommonJS module to preload (option can be repeated) | help + man |
--secure-heap ... | Specify the size of the OpenSSL secure heap. | help + man |
--secure-heap-min ... | Specify the minimum allocation from the OpenSSL secure heap. | help + man |
--snapshot-blob ... | Path to the snapshot blob that's either the result of snapshotbuilding, or the blob that is used to restore the application state | help |
--test | Starts the Node.js command line test runner. | help + man |
--test-concurrency ... | The maximum number of test files that the test runner CLI will execute concurrently. | help + man |
--test-name-pattern ... | A regular expression that configures the test runner to only execute tests whose name matches the provided pattern. | help + man |
--test-only | Configures the test runner to only execute top level tests that have the only option set. | help + man |
--test-reporter ... | report test output using the given reporter | help + man |
--test-reporter-destination ... | The destination for the corresponding test reporter. | help + man |
--test-shard ... | Test suite shard to execute in a format of <index>/<total>. | help + man |
--throw-deprecation | throw an exception on deprecations | help + man |
--title ... | the process title to use on startup | help + man |
--tls-cipher-list ... | Specify an alternative default TLS cipher list. | help + man |
--tls-keylog ... | log TLS decryption keys to named file for traffic analysis | help + man |
--tls-max-v1.2 | set default TLS maximum to TLSv1.2 (default: TLSv1.3) | help + man |
--tls-max-v1.3 | set default TLS maximum to TLSv1.3 (default: TLSv1.3) | help + man |
--tls-min-v1.0 | set default TLS minimum to TLSv1.0 (default: TLSv1.2) | help + man |
--tls-min-v1.1 | set default TLS minimum to TLSv1.1 (default: TLSv1.2) | help + man |
--tls-min-v1.2 | set default TLS minimum to TLSv1.2 (default: TLSv1.2) | help + man |
--tls-min-v1.3 | set default TLS minimum to TLSv1.3 (default: TLSv1.2) | help + man |
--trace-atomics-wait | Print short summaries of calls to Atomics.wait(). | help + man |
--trace-deprecation | Print stack traces for deprecations. | help + man |
--trace-event-categories ... | A comma-separated list of categories that should be traced when trace event tracing is enabled using --trace-events-enabled. | help + man |
--trace-event-file-pattern ... | Template string specifying the filepath for the trace-events data, it supports ${rotation} and ${pid}. | help + man |
--trace-exit | Prints a stack trace whenever an environment is exited proactively, i.e. invoking process.exit(). | help + man |
--trace-sigint | enable printing JavaScript stacktrace on SIGINT | help + man |
--trace-sync-io | Print a stack trace whenever synchronous I/O is detected after the first turn of the event loop. | help + man |
--trace-tls | Prints TLS packet trace information to stderr. | help + man |
--trace-uncaught | show stack traces for the `throw` behind uncaught exceptions | help + man |
--trace-warnings | Print stack traces for process warnings (including deprecations). | help + man |
--track-heap-objects | Track heap object allocations for heap snapshots. | help + man |
--unhandled-rejections ... | Define the behavior for unhandled rejections. | help + man |
--use-bundled-ca | Use bundled Mozilla CA store as supplied by current Node.js version or use OpenSSL's default CA store. | help + man |
--use-largepages ... | Re-map the Node.js static code to large memory pages at startup. | help + man |
--use-openssl-ca | use OpenSSL's default CA store (default) | help |
--v8-options | Print V8 command-line options. | help + man |
--v8-pool-size ... | Set V8's thread pool size which will be used to allocate background jobs. | help + man |
-v, --version | print Node.js version | help + man |
--watch | run in watch mode | help |
--watch-path ... | path to watch | help |
--watch-preserve-output | preserve outputs on watch mode restart | help |
--zero-fill-buffers | Automatically zero-fills all newly allocated Buffer and SlowBuffer instances. | help + man |
--experimental-shadow-realm | Use this flag to enable ShadowRealm support. (in the manual page but not in --help) | man |
--experimental-wasi-unstable-preview1 | Enable experimental WebAssembly System Interface support. (in the manual page but not in --help) | man |
--experimental-wasm-modules | Enable experimental WebAssembly module support. (in the manual page but not in --help) | man |
--inspect-brk host:]port | Activate inspector on host:port and break at start of user script. (in the manual page but not in --help) | man |
--napi-modules | This option is a no-op. (in the manual page but not in --help) | man |
--report-uncaught-exception | Enables diagnostic report to be generated on un-caught exceptions. (in the manual page but not in --help) | man |
--trace-events-enabled | Enable the collection of trace event tracing information. (in the manual page but not in --help) | man |