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
--allow-addons allow use of addons when any
permissions are set
--allow-child-process allow use of child process when any
permissions are set
--allow-fs-read=... allow permissions to read the
filesystem
--allow-fs-write=... allow permissions to write in the
filesystem
--allow-wasi allow wasi when any permissions are set
--allow-worker allow worker threads when any
permissions are set
--build-snapshot Generate a snapshot blob when the
process exits.
--build-snapshot-config=... Generate a snapshot blob when the
process exits using aJSON configuration
in the specified path.
-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__
--disable-warning=... silence specific process warnings
--disable-wasm-trap-handler Disable trap-handler-based WebAssembly
bound checks. V8 will insert inline
bound checks when compiling WebAssembly
which may slow down performance.
--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) 'ipv6first' (IPv6 addresses
are placed before IPv4 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-source-maps Source Map V3 support for stack traces
--env-file=... set environment variables from supplied
file
--env-file-if-exists=... set environment variables from supplied
file
-e, --eval=... evaluate script
--experimental-default-type=...
set module system to use by default
--experimental-eventsource experimental EventSource API
--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-network-inspection
experimental network inspection support
--experimental-permission enable the permission system
--experimental-policy=... use the specified file as a security
policy
--experimental-print-required-tla
Print pending top-level await. If
--experimental-require-module is true,
evaluate asynchronous graphs loaded by
`require()` but do not run the
microtasks, in order to to find and
print top-level await in the graph
--experimental-sea-config=...
Generate a blob that can be embedded
into the single executable application
--experimental-test-coverage
enable code coverage in the test runner
--experimental-test-module-mocks
enable module mocking in the test
runner
--experimental-vm-modules experimental ES Module support in vm
module
--experimental-wasm-modules experimental ES Module support for
webassembly modules
--experimental-websocket experimental WebSocket API
--expose-gc expose gc extension
--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)
--inspect-wait[=[host:]port]
activate inspector on host:port and
wait for debugger to be attached
-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))
--network-family-autoselection-attempt-timeout=...
Sets the default value for the network
family autoselection attempt timeout.
--no-addons disable loading native addons
--no-deprecation silence deprecation warnings
--no-experimental-detect-module
when ambiguous modules fail to evaluate
because they contain ES module syntax,
try again to evaluate them as ES
modules
--no-experimental-fetch experimental Fetch API
--no-experimental-global-customevent
expose experimental CustomEvent on the
global scope
--no-experimental-global-webcrypto
expose experimental Web Crypto API on
the global scope
--no-experimental-repl-await
experimental await keyword support in
REPL
--no-experimental-require-module
Allow loading synchronous ES Modules in
require().
--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
--enable-network-family-autoselection, --no-network-family-autoselection
Disable network address family
autodetection algorithm
--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-exclude-network exclude network interface diagnostics.
(default: false)
--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-force-exit force test runner to exit upon
completion
--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
--test-timeout=... specify test runner timeout
--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-promises show stack traces on promise
initialization and resolution
--trace-require-module=... Print access to require(esm). Options
are 'all' (print all usage) and
'no-node-modules' (excluding usage from
the node_modules folder)
--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 (145)
| Option | Description | Source |
|---|---|---|
--abort-on-uncaught-exception | aborting instead of exiting causes a core file to be generated for analysis | help |
--allow-addons | allow use of addons when any permissions are set | help |
--allow-child-process | allow use of child process when any permissions are set | help |
--allow-fs-read ... | allow permissions to read the filesystem | help |
--allow-fs-write ... | allow permissions to write in the filesystem | help |
--allow-wasi | allow wasi when any permissions are set | help |
--allow-worker | allow worker threads when any permissions are set | help |
--build-snapshot | Generate a snapshot blob when the process exits. | help |
-c, --check | syntax check script without executing | help |
--completion-bash | print source-able bash completion script | help |
-C, --conditions ... | additional user conditions for conditional exports and imports | help |
--cpu-prof | Start the V8 CPU profiler on start up, and write the CPU profile to disk before exit. | help |
--cpu-prof-dir ... | Directory where the V8 profiles generated by --cpu-prof will be placed. | help |
--cpu-prof-interval ... | specified sampling interval in microseconds for the V8 CPU profile generated with --cpu-prof. | help |
--cpu-prof-name ... | specified file name of the V8 CPU profile generated with --cpu-prof | help |
--diagnostic-dir ... | set dir for all output files (default: current working directory) | help |
--disable-proto ... | disable Object.prototype.__proto__ | help |
--disable-warning ... | silence specific process warnings | help |
--disallow-code-generation-from-strings | disallow eval and friends | help |
--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 crypto at startup | help |
--enable-source-maps | Source Map V3 support for stack traces | help |
--env-file ... | set environment variables from supplied file | help |
--env-file-if-exists ... | set environment variables from supplied file | help |
-e, --eval ... | evaluate script | help |
--experimental-default-type ... | set module system to use by default | help |
--experimental-eventsource | experimental EventSource API | help |
--experimental-import-meta-resolve | experimental ES Module import.meta.resolve() parentURL support | help |
--loader, --experimental-loader ... | use the specified module as a custom loader | help |
--experimental-network-imports | experimental https: support for the ES Module loader | help |
--experimental-network-inspection | experimental network inspection support | help |
--experimental-permission | enable the permission system | help |
--experimental-policy ... | use the specified file as a security policy | help |
--experimental-print-required-tla | Print pending top-level await. | help |
--experimental-sea-config ... | Generate a blob that can be embedded into the single executable application | help |
--experimental-test-coverage | enable code coverage in the test runner | help |
--experimental-test-module-mocks | enable module mocking in the test runner | help |
--experimental-vm-modules | experimental ES Module support in vm module | help |
--experimental-websocket | experimental WebSocket API | help |
--expose-gc | expose gc extension | help |
--force-context-aware | disable loading non-context-aware addons | help |
--force-fips | force FIPS crypto (cannot be disabled) | help |
--force-node-api-uncaught-exceptions-policy | enforces 'uncaughtException' event on Node API asynchronous callbacks | help |
--frozen-intrinsics | experimental frozen intrinsics support | help |
--heap-prof | Start the V8 heap profiler on start up, and write the heap profile to disk before exit. | help |
--heap-prof-dir ... | Directory where the V8 heap profiles generated by --heap-prof will be placed. | help |
--heap-prof-interval ... | specified sampling interval in bytes for the V8 heap profile generated with | help |
--heap-prof-name ... | specified file name of the V8 heap profile generated with --heap-prof | help |
--heapsnapshot-near-heap-limit ... | Generate heap snapshots whenever V8 is approaching the heap limit. | help |
--heapsnapshot-signal ... | Generate heap snapshot on specified signal | help |
-h, --help | print node command line options (currently set) | help |
--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 |
--import ... | ES module to preload (option can be repeated) | help |
--input-type ... | set module type for string input | help |
--insecure-http-parser | use an insecure HTTP parser that accepts invalid HTTP headers | help |
--inspect host:]port | activate inspector on host:port (default: 127.0.0.1:9229) | help |
--debug-port, --inspect-port host:]port | set host:port for inspector | help |
--inspect-publish-uid ... | comma separated list of destinations for inspector uid(default: stderr,http) | help |
--inspect-wait host:]port | activate inspector on host:port and wait for debugger to be attached | help |
-i, --interactive | always enter the REPL even if stdin does not appear to be a terminal | help |
--interpreted-frames-native-stack | help system profilers to translate JavaScript interpreted frames | help |
--jitless | disable runtime allocation of executable memory | help |
--max-http-header-size ... | set the maximum size of HTTP headers (default: 16384 (16KB)) | help |
--network-family-autoselection-attempt-timeout ... | Sets the default value for the network family autoselection attempt timeout. | help |
--no-addons | disable loading native addons | help |
--no-deprecation | silence deprecation warnings | help |
--no-experimental-detect-module | when ambiguous modules fail to evaluate because they contain ES module syntax, try again to evaluate them as ES modules | help |
--no-experimental-fetch | experimental Fetch API | help |
--no-experimental-global-customevent | expose experimental CustomEvent on the global scope | help |
--no-experimental-global-webcrypto | expose experimental Web Crypto API on the global scope | help |
--no-experimental-repl-await | experimental await keyword support in REPL | help |
--no-experimental-require-module | Allow loading synchronous ES Modules in require(). | help |
--no-extra-info-on-fatal-exception | hide extra information on fatal exception that causes exit | help |
--no-force-async-hooks-checks | disable checks for async_hooks | help |
--no-global-search-paths | disable global module search paths | help |
--enable-network-family-autoselection, --no-network-family-autoselection | Disable network address family autodetection algorithm | help |
--no-warnings | silence all process warnings | help |
--node-memory-debug | Run with extra debug checks for memory leaks in Node.js itself | help |
--openssl-config ... | load OpenSSL configuration from the specified file (overrides OPENSSL_CONF) | help |
--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 |
--policy-integrity ... | ensure the security policy contents match the specified integrity | help |
--preserve-symlinks | preserve symbolic links when resolving | help |
--preserve-symlinks-main | preserve symbolic links when resolving the main module | help |
-p, --print ... | evaluate script and print result | help |
--prof | Generate V8 profiler output. | help |
--prof-process | process V8 profiler output generated using --prof | help |
--redirect-warnings ... | write warnings to file instead of stderr | help |
--report-compact | output compact single-line JSON | help |
--report-directory, --report-dir ... | define custom report pathname. | help |
--report-exclude-network | exclude network interface diagnostics. | help |
--report-filename ... | define custom report file name. | help |
--report-on-fatalerror | generate diagnostic report on fatal (internal) errors | help |
--report-on-signal | generate diagnostic report upon receiving signals | help |
--report-signal ... | causes diagnostic report to be produced on provided signal, unsupported in Windows. | help |
-r, --require ... | CommonJS module to preload (option can be repeated) | help |
--secure-heap ... | total size of the OpenSSL secure heap | help |
--secure-heap-min ... | minimum allocation size from the OpenSSL secure heap | help |
--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 | launch test runner on startup | help |
--test-concurrency ... | specify test runner concurrency | help |
--test-force-exit | force test runner to exit upon completion | help |
--test-name-pattern ... | run tests whose name matches this regular expression | help |
--test-only | run tests with 'only' option set | help |
--test-reporter ... | report test output using the given reporter | help |
--test-reporter-destination ... | report given reporter to the given destination | help |
--test-shard ... | run test at specific shard | help |
--test-timeout ... | specify test runner timeout | help |
--throw-deprecation | throw an exception on deprecations | help |
--title ... | the process title to use on startup | help |
--tls-cipher-list ... | use an alternative default TLS cipher list | help |
--tls-keylog ... | log TLS decryption keys to named file for traffic analysis | help |
--tls-max-v1.2 | set default TLS maximum to TLSv1.2 (default: TLSv1.3) | help |
--tls-max-v1.3 | set default TLS maximum to TLSv1.3 (default: TLSv1.3) | help |
--tls-min-v1.0 | set default TLS minimum to TLSv1.0 (default: TLSv1.2) | help |
--tls-min-v1.1 | set default TLS minimum to TLSv1.1 (default: TLSv1.2) | help |
--tls-min-v1.2 | set default TLS minimum to TLSv1.2 (default: TLSv1.2) | help |
--tls-min-v1.3 | set default TLS minimum to TLSv1.3 (default: TLSv1.2) | help |
--trace-atomics-wait | (deprecated) trace Atomics.wait() operations | help |
--trace-deprecation | show stack traces on deprecations | help |
--trace-event-categories ... | comma separated list of trace event categories to record | help |
--trace-event-file-pattern ... | Template string specifying the filepath for the trace-events data, it supports ${rotation} and ${pid}. | help |
--trace-exit | show stack trace when an environment exits | help |
--trace-promises | show stack traces on promise initialization and resolution | help |
--trace-require-module ... | Print access to require(esm). | help |
--trace-sigint | enable printing JavaScript stacktrace on SIGINT | help |
--trace-sync-io | show stack trace when use of sync IO is detected after the first tick | help |
--trace-tls | prints TLS packet trace information to stderr | help |
--trace-uncaught | show stack traces for the `throw` behind uncaught exceptions | help |
--trace-warnings | show stack traces on process warnings | help |
--track-heap-objects | track heap object allocations for heap snapshots | help |
--unhandled-rejections ... | define unhandled rejections behavior. | help |
--use-bundled-ca | use bundled CA store | help |
--use-largepages ... | Map the Node.js static code to large pages. | help |
--use-openssl-ca | use OpenSSL's default CA store (default) | help |
--v8-options | print V8 command line options | help |
--v8-pool-size ... | set V8's thread pool size | help |
-v, --version | print Node.js version | help |
--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-fill all newly allocated Buffer and SlowBuffer instances | help |