Skip to content

Commit

Permalink
cli: document --inspect port 0 behavior
Browse files Browse the repository at this point in the history
PR-URL: #53782
Reviewed-By: Kohei Ueno <kohei.ueno119@gmail.com>
  • Loading branch information
RedYetiDev authored and targos committed Jul 28, 2024
1 parent 8e66a18 commit 66f7c59
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions doc/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -1448,7 +1448,8 @@ or poisoning attack. Avoid using this option.
added: v6.3.0
-->

Activate inspector on `host:port`. Default is `127.0.0.1:9229`.
Activate inspector on `host:port`. Default is `127.0.0.1:9229`. If port `0` is
specified, a random available port will be used.

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
Expand Down Expand Up @@ -1482,7 +1483,8 @@ added: v7.6.0
-->

Activate inspector on `host:port` and break at start of user script.
Default `host:port` is `127.0.0.1:9229`.
Default `host:port` is `127.0.0.1:9229`. If port `0` is specified,
a random available port will be used.

See [V8 Inspector integration for Node.js][] for further explanation on Node.js debugger.

Expand All @@ -1495,7 +1497,8 @@ added: v7.6.0
Set the `host:port` to be used when the inspector is activated.
Useful when activating the inspector by sending the `SIGUSR1` signal.

Default host is `127.0.0.1`.
Default host is `127.0.0.1`. If port `0` is specified,
a random available port will be used.

See the [security warning][] below regarding the `host`
parameter usage.
Expand All @@ -1514,7 +1517,8 @@ added: v22.2.0
-->

Activate inspector on `host:port` and wait for debugger to be attached.
Default `host:port` is `127.0.0.1:9229`.
Default `host:port` is `127.0.0.1:9229`. If port `0` is specified,
a random available port will be used.

See [V8 Inspector integration for Node.js][] for further explanation on Node.js debugger.

Expand Down

0 comments on commit 66f7c59

Please sign in to comment.