jiangcuo/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2025-05-15 00:52:29 +00:00
Code Issues Actions 12 Packages Projects Releases Wiki Activity
4b97c3addb
node/deps/npm/docs/content/cli-commands/npm-help-search.md
Ruy Adorno 4b97c3addb deps: update npm to 6.13.0 
PR-URL: https://github.com/nodejs/node/pull/30271
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-11-09 20:13:43 -08:00

906 B
Executable File
Raw Blame History

section title description
cli-commands npm-help-search Search npm help documentation

npm-help-search

Search npm help documentation

Synopsis

npm help-search <text>

Description

This command will search the npm markdown documentation files for the terms provided, and then list the results, sorted by relevance.

If only one result is found, then it will show that help topic.

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.

Configuration

long

  • Type: Boolean
  • Default: false

If true, the "long" flag will cause help-search to output context around where the terms were found in the documentation.

If false, then help-search will just list out the help topics found.

See Also