diff options
Diffstat (limited to 'docs/content/commands/npm-help-search.md')
-rw-r--r-- | docs/content/commands/npm-help-search.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/content/commands/npm-help-search.md b/docs/content/commands/npm-help-search.md new file mode 100644 index 000000000..872e180a0 --- /dev/null +++ b/docs/content/commands/npm-help-search.md @@ -0,0 +1,39 @@ +--- +title: npm-help-search +section: 1 +description: Search npm help documentation +--- + +### Synopsis + +```bash +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 + +* [npm](/cli-commands/npm) +* [npm help](/cli-commands/help) |