2025-04-10 14:36:22 -07:00
.TH "NPM-HELP-SEARCH" "1" "April 2025" "NPM@11.3.0" ""
2011-11-26 09:21:03 -08:00
.SH "NAME"
2022-12-06 22:18:33 -05:00
\fB npm-help-search\fR - Search npm help documentation
.SS "Synopsis"
2014-09-24 14:41:07 -07:00
.P
.RS 2
2014-11-04 15:08:12 -08:00
.nf
2022-12-06 22:18:33 -05:00
npm help-search <text>
2014-11-04 15:08:12 -08:00
.fi
2014-09-24 14:41:07 -07:00
.RE
2021-03-23 14:58:11 -04:00
.P
2022-12-06 22:18:33 -05:00
Note: This command is unaware of workspaces.
.SS "Description"
2014-09-24 14:41:07 -07:00
.P
2022-12-06 22:18:33 -05:00
This command will search the npm markdown documentation files for the terms provided, and then list the results, sorted by relevance.
2011-11-26 09:21:03 -08:00
.P
2022-12-06 22:18:33 -05:00
If only one result is found, then it will show that help topic.
2011-11-26 09:21:03 -08:00
.P
2022-12-06 22:18:33 -05:00
If the argument to \fB npm help\fR is not a known help topic, then it will call \fB help-search\fR . It is rarely if ever necessary to call this command directly.
.SS "Configuration"
.SS "\fBlong\fR"
2014-09-24 14:41:07 -07:00
.RS 0
2022-12-06 22:18:33 -05:00
.IP \(bu 4
2016-03-29 23:30:51 -07:00
Default: false
2022-12-06 22:18:33 -05:00
.IP \(bu 4
2021-05-20 15:54:50 -04:00
Type: Boolean
2022-12-06 22:18:33 -05:00
.RE 0
2014-09-24 14:41:07 -07:00
2011-11-26 09:21:03 -08:00
.P
2022-12-06 22:18:33 -05:00
Show extended information in \fB ls\fR , \fB search\fR , and \fB help-search\fR .
.SS "See Also"
2014-09-24 14:41:07 -07:00
.RS 0
2022-12-06 22:18:33 -05:00
.IP \(bu 4
2011-11-26 09:21:03 -08:00
npm help npm
2022-12-06 22:18:33 -05:00
.IP \(bu 4
2019-11-18 21:01:39 +02:00
npm help help
2022-12-06 22:18:33 -05:00
.RE 0