npm-help - Man Page

Name

npm-help — Get help on npm

Synopsis

npm help <term> [<terms..>]

Note: This command is unaware of workspaces.

Description

If supplied a topic, then show the appropriate documentation page.

If the topic does not exist, or if multiple terms are provided, then npm will run the help-search command to find a match.  Note that, if help-search finds a single subject, then it will run help on that topic, so unique matches are equivalent to specifying a topic name.

Configuration

<!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js -->

viewer

  • Default: "man" on Posix, "browser" on Windows
  • Type: String

The program to use to view help content.

Set to "browser" to view html help content in the default web browser. <!-- automatically generated, do not edit manually --> <!-- see lib/utils/config/definitions.js -->

<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->

See Also

  • npm help npm
  • npm help folders
  • npm help config
  • npm help npmrc
  • npm help package.json
  • npm help help-search

Info

October 2021