@cryptotaxi247 / documentation
Code Commits Issues Pulls Sessions CI/CD
main
@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
mdx 72 lines 1.95 KB
Raw
1 ---
2 title: npm-help
3 section: 1
4 description: Get help on npm
5 github_repo: npm/cli
6 github_branch: latest
7 github_path: docs/lib/content/commands/npm-help.md
8 redirect_from:
9 - /cli-commands/help
10 - /cli-commands/npm-help
11 - /cli-documentation/cli-commands/help
12 - /cli-documentation/cli-commands/npm-help
13 - /cli-documentation/commands/help
14 - /cli-documentation/commands/npm-help
15 - /cli-documentation/help
16 - /cli-documentation/npm-help
17 - /cli-documentation/v11/cli-commands/help
18 - /cli-documentation/v11/cli-commands/npm-help
19 - /cli-documentation/v11/commands/help
20 - /cli-documentation/v11/commands/npm-help
21 - /cli-documentation/v11/help
22 - /cli-documentation/v11/npm-help
23 - /cli/cli-commands/help
24 - /cli/cli-commands/npm-help
25 - /cli/commands/help
26 - /cli/commands/npm-help
27 - /cli/help
28 - /cli/npm-help
29 - /cli/v11/cli-commands/help
30 - /cli/v11/cli-commands/npm-help
31 - /cli/v11/commands/help
32 - /cli/v11/help
33 - /cli/v11/npm-help
34 - /commands/help
35 - /commands/npm-help
36 ---
37
38 ### Synopsis
39
40 ```bash
41 npm help <term> [<terms..>]
42
43 alias: hlep
44 ```
45
46 Note: This command is unaware of workspaces.
47
48 ### Description
49
50 If supplied a topic, then show the appropriate documentation page.
51
52 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.
53
54 ### Configuration
55
56 #### `viewer`
57
58 - Default: "man" on Posix, "browser" on Windows
59 - Type: String
60
61 The program to use to view help content.
62
63 Set to `"browser"` to view html help content in the default web browser.
64
65 ### See Also
66
67 - [npm](/cli/v11/commands/npm)
68 - [npm folders](/cli/v11/configuring-npm/folders)
69 - [npm config](/cli/v11/commands/npm-config)
70 - [npmrc](/cli/v11/configuring-npm/npmrc)
71 - [package.json](/cli/v11/configuring-npm/package-json)
72 - [npm help-search](/cli/v11/commands/npm-help-search)