summaryrefslogtreecommitdiff
path: root/deps/npm/docs/content/cli-commands/npm-help-search.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/docs/content/cli-commands/npm-help-search.md')
-rwxr-xr-xdeps/npm/docs/content/cli-commands/npm-help-search.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/deps/npm/docs/content/cli-commands/npm-help-search.md b/deps/npm/docs/content/cli-commands/npm-help-search.md
new file mode 100755
index 0000000000..b3b863006f
--- /dev/null
+++ b/deps/npm/docs/content/cli-commands/npm-help-search.md
@@ -0,0 +1,43 @@
+---
+section: cli-commands
+title: npm-help-search
+description: Search npm help documentation
+---
+
+# npm-help-search
+
+## 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/npm-help)