Skip to content

Commit 0c00b65

Browse files
Noj Vekitaloacasas
Noj Vek
authored andcommitted
Fix #7065: cli help documentation for --inspect
Adding documentation to node.1 and cli.md PR-URL: #11660 Reviewed-By: Eugene Ostroukhov <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 60ad7af commit 0c00b65

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

doc/api/cli.md

+21
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,26 @@ Follows `require()`'s module resolution
9494
rules. `module` may be either a path to a file, or a node module name.
9595

9696

97+
### `--inspect[=host:port]`
98+
<!-- YAML
99+
added: v6.3.0
100+
-->
101+
102+
Activate inspector on host:port. Default is 127.0.0.1:9229.
103+
104+
V8 inspector integration allows tools such as Chrome DevTools and IDEs to debug
105+
and profile Node.js instances. The tools attach to Node.js instances via a
106+
tcp port and communicate using the [Chrome Debugging Protocol][].
107+
108+
109+
### `--inspect-brk[=host:port]`
110+
<!-- YAML
111+
added: v7.6.0
112+
-->
113+
114+
Activate inspector on host:port and break at start of user script.
115+
116+
97117
### `--no-deprecation`
98118
<!-- YAML
99119
added: v0.8.0
@@ -425,6 +445,7 @@ OpenSSL, it may cause them to trust the same CAs as node.
425445

426446
[emit_warning]: process.html#process_process_emitwarning_warning_name_ctor
427447
[Buffer]: buffer.html#buffer_buffer
448+
[Chrome Debugging Protocol]: https://chromedevtools.github.io/debugger-protocol-viewer
428449
[debugger]: debugger.html
429450
[REPL]: repl.html
430451
[SlowBuffer]: buffer.html#buffer_class_slowbuffer

doc/node.1

+11
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,17 @@ Open the REPL even if stdin does not appear to be a terminal.
9292
Preload the specified module at startup. Follows `require()`'s module resolution
9393
rules. \fImodule\fR may be either a path to a file, or a node module name.
9494

95+
.TP
96+
.BR \-\-inspect \fI[=host:port]\fR
97+
Activate inspector on host:port. Default is 127.0.0.1:9229.
98+
99+
V8 Inspector integration allows attaching Chrome DevTools and IDEs to Node.js
100+
instances for debugging and profiling. It uses the Chrome Debugging Protocol.
101+
102+
.TP
103+
.BR \-\-inspect-brk \fI[=host:port]\fR
104+
Activate inspector on host:port and break at start of user script.
105+
95106
.TP
96107
.BR \-\-no\-deprecation
97108
Silence deprecation warnings.

0 commit comments

Comments
 (0)