dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2
@reggi/path-to-regexp
dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2
dependabot/npm_and_yarn/main/eslint-10.4.0
dependabot/npm_and_yarn/main/npmcli/eslint-config-7.0.0
dependabot/npm_and_yarn/main/proc-log-7.0.0
dependabot/npm_and_yarn/npm_and_yarn-826852524d
dependabot/npm_and_yarn/npm_and_yarn-ab9a7f4bc2
deprecate-totp-2fa
dhei/classic-tokens
gat-bypass-2fa-docs
jpg619/fix-accessibility-content-flow
jpg619/version-bump-tar-2
kartykp/gat-bypass-2fa-docs
kartykp/upgrade-path-to-regex
main
maitxn/version-bump-tar
patch-1
reggi/cache-based-on-version
reggi/dev-engines
reggi/fix-transform-prettier
reggi/overrides
update-search-sensitivity
| 1 | --- |
| 2 | title: npm-help |
| 3 | section: 1 |
| 4 | description: Get help on npm |
| 5 | github_repo: npm/cli |
| 6 | github_branch: release/v8 |
| 7 | github_path: docs/lib/content/commands/npm-help.md |
| 8 | redirect_from: |
| 9 | - /cli-documentation/v8/cli-commands/help |
| 10 | - /cli-documentation/v8/cli-commands/npm-help |
| 11 | - /cli-documentation/v8/commands/help |
| 12 | - /cli-documentation/v8/commands/npm-help |
| 13 | - /cli-documentation/v8/help |
| 14 | - /cli-documentation/v8/npm-help |
| 15 | - /cli/v8/cli-commands/help |
| 16 | - /cli/v8/cli-commands/npm-help |
| 17 | - /cli/v8/commands/help |
| 18 | - /cli/v8/help |
| 19 | - /cli/v8/npm-help |
| 20 | --- |
| 21 | |
| 22 | ### Synopsis |
| 23 | |
| 24 | ```bash |
| 25 | npm help <term> [<terms..>] |
| 26 | |
| 27 | alias: hlep |
| 28 | ``` |
| 29 | |
| 30 | Note: This command is unaware of workspaces. |
| 31 | |
| 32 | ### Description |
| 33 | |
| 34 | If supplied a topic, then show the appropriate documentation page. |
| 35 | |
| 36 | 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. |
| 37 | |
| 38 | ### Configuration |
| 39 | |
| 40 | #### `viewer` |
| 41 | |
| 42 | - Default: "man" on Posix, "browser" on Windows |
| 43 | - Type: String |
| 44 | |
| 45 | The program to use to view help content. |
| 46 | |
| 47 | Set to `"browser"` to view html help content in the default web browser. |
| 48 | |
| 49 | ### See Also |
| 50 | |
| 51 | - [npm](/cli/v8/commands/npm) |
| 52 | - [npm folders](/cli/v8/configuring-npm/folders) |
| 53 | - [npm config](/cli/v8/commands/npm-config) |
| 54 | - [npmrc](/cli/v8/configuring-npm/npmrc) |
| 55 | - [package.json](/cli/v8/configuring-npm/package-json) |
| 56 | - [npm help-search](/cli/v8/commands/npm-help-search) |