reggi/overrides
@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-search |
| 3 | section: 1 |
| 4 | description: Search npm help documentation |
| 5 | github_repo: npm/cli |
| 6 | github_branch: latest |
| 7 | github_path: docs/lib/content/commands/npm-help-search.md |
| 8 | redirect_from: |
| 9 | - /cli-commands/help-search |
| 10 | - /cli-commands/npm-help-search |
| 11 | - /cli-documentation/cli-commands/help-search |
| 12 | - /cli-documentation/cli-commands/npm-help-search |
| 13 | - /cli-documentation/commands/help-search |
| 14 | - /cli-documentation/commands/npm-help-search |
| 15 | - /cli-documentation/help-search |
| 16 | - /cli-documentation/npm-help-search |
| 17 | - /cli-documentation/v10/cli-commands/help-search |
| 18 | - /cli-documentation/v10/cli-commands/npm-help-search |
| 19 | - /cli-documentation/v10/commands/help-search |
| 20 | - /cli-documentation/v10/commands/npm-help-search |
| 21 | - /cli-documentation/v10/help-search |
| 22 | - /cli-documentation/v10/npm-help-search |
| 23 | - /cli/cli-commands/help-search |
| 24 | - /cli/cli-commands/npm-help-search |
| 25 | - /cli/commands/help-search |
| 26 | - /cli/commands/npm-help-search |
| 27 | - /cli/help-search |
| 28 | - /cli/npm-help-search |
| 29 | - /cli/v10/cli-commands/help-search |
| 30 | - /cli/v10/cli-commands/npm-help-search |
| 31 | - /cli/v10/commands/help-search |
| 32 | - /cli/v10/help-search |
| 33 | - /cli/v10/npm-help-search |
| 34 | - /commands/help-search |
| 35 | - /commands/npm-help-search |
| 36 | --- |
| 37 | |
| 38 | ### Synopsis |
| 39 | |
| 40 | ```bash |
| 41 | npm help-search <text> |
| 42 | ``` |
| 43 | |
| 44 | Note: This command is unaware of workspaces. |
| 45 | |
| 46 | ### Description |
| 47 | |
| 48 | This command will search the npm markdown documentation files for the terms provided, and then list the results, sorted by relevance. |
| 49 | |
| 50 | If only one result is found, then it will show that help topic. |
| 51 | |
| 52 | 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. |
| 53 | |
| 54 | ### Configuration |
| 55 | |
| 56 | #### `long` |
| 57 | |
| 58 | - Default: false |
| 59 | - Type: Boolean |
| 60 | |
| 61 | Show extended information in `ls`, `search`, and `help-search`. |
| 62 | |
| 63 | ### See Also |
| 64 | |
| 65 | - [npm](/cli/v10/commands/npm) |
| 66 | - [npm help](/cli/v10/commands/npm-help) |