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