2025-04-10 14:36:22 -07:00
.TH "NPM-HELP" "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\fR - Get help on npm
.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 <term> \[ lB]<terms..>\[ rB]
2022-02-24 21:41:49 +00:00
alias: hlep
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
If supplied a topic, then show the appropriate documentation page.
2011-11-26 09:21:03 -08:00
.P
2022-12-06 22:18:33 -05:00
If the topic does not exist, or if multiple terms are provided, then npm will run the \fB help-search\fR command to find a match. Note that, if \fB help-search\fR finds a single subject, then it will run \fB help\fR on that topic, so unique matches are equivalent to specifying a topic name.
.SS "Configuration"
.SS "\fBviewer\fR"
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
Default: "man" on Posix, "browser" on Windows
2022-12-06 22:18:33 -05:00
.IP \(bu 4
2021-05-20 15:54:50 -04:00
Type: String
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
The program to use to view help content.
2011-11-26 09:21:03 -08:00
.P
2022-12-06 22:18:33 -05:00
Set to \fB "browser"\fR to view html help content in the default web browser.
.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-05 14:55:08 -05:00
npm help folders
2022-12-06 22:18:33 -05:00
.IP \(bu 4
2019-11-18 21:01:39 +02:00
npm help config
2022-12-06 22:18:33 -05:00
.IP \(bu 4
2019-11-05 14:55:08 -05:00
npm help npmrc
2022-12-06 22:18:33 -05:00
.IP \(bu 4
\fB package.json\fR \fI \(la /configuring-npm/package-json\(ra \fR
.IP \(bu 4
npm help help-search
.RE 0