@cryptotaxi247 / documentation-1
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 50 lines 1.38 KB
Raw
1 ---
2 title: npm-help-search
3 section: 1
4 description: Search npm help documentation
5 github_repo: npm/cli
6 github_branch: release/v6
7 github_path: docs/content/commands/npm-help-search.md
8 redirect_from:
9 - /cli-documentation/v6/cli-commands/help-search
10 - /cli-documentation/v6/cli-commands/npm-help-search
11 - /cli-documentation/v6/commands/help-search
12 - /cli-documentation/v6/commands/npm-help-search
13 - /cli-documentation/v6/help-search
14 - /cli-documentation/v6/npm-help-search
15 - /cli/v6/cli-commands/help-search
16 - /cli/v6/cli-commands/npm-help-search
17 - /cli/v6/commands/help-search
18 - /cli/v6/help-search
19 - /cli/v6/npm-help-search
20 ---
21
22 ### Synopsis
23
24 ```bash
25 npm help-search <text>
26 ```
27
28 ### Description
29
30 This command will search the npm markdown documentation files for the terms provided, and then list the results, sorted by relevance.
31
32 If only one result is found, then it will show that help topic.
33
34 If the argument to `npm help` is not a known help topic, then it will call `help-search`. It is rarely if ever necessary to call this command directly.
35
36 ### Configuration
37
38 #### long
39
40 - Type: Boolean
41 - Default: false
42
43 If true, the "long" flag will cause help-search to output context around where the terms were found in the documentation.
44
45 If false, then help-search will just list out the help topics found.
46
47 ### See Also
48
49 - [npm](/cli/v6/commands/npm)
50 - [npm help](/cli/v6/commands/npm-help)