jiangcuo/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2025-05-15 10:01:49 +00:00
Code Issues Actions 12 Packages Projects Releases Wiki Activity
c975dff3c0
node/deps/npm/docs/content/commands/npm-help-search.md
Ruy Adorno 73b3e06c91
deps: upgrade npm to 7.7.0 
PR-URL: https://github.com/nodejs/node/pull/37879
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2021-03-23 22:10:30 -04:00

880 B
Raw Blame History

title section description
npm-help-search 1 Search npm help documentation

Synopsis

npm help-search <text>

Note: This command is unaware of workspaces.

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