summaryrefslogtreecommitdiff
path: root/deps/npm/docs/content/cli-commands/npm-completion.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/docs/content/cli-commands/npm-completion.md')
-rw-r--r--deps/npm/docs/content/cli-commands/npm-completion.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/deps/npm/docs/content/cli-commands/npm-completion.md b/deps/npm/docs/content/cli-commands/npm-completion.md
new file mode 100644
index 0000000000..59bfca503e
--- /dev/null
+++ b/deps/npm/docs/content/cli-commands/npm-completion.md
@@ -0,0 +1,42 @@
+---
+section: cli-commands
+title: npm-completion
+description: Tab Completion for npm
+---
+
+# npm-completion(1)
+
+## Tab Completion for npm
+
+### Synopsis
+```bash
+source <(npm completion)
+```
+
+### Description
+
+Enables tab-completion in all npm commands.
+
+The synopsis above
+loads the completions into your current shell. Adding it to
+your ~/.bashrc or ~/.zshrc will make the completions available
+everywhere:
+
+```bash
+npm completion >> ~/.bashrc
+npm completion >> ~/.zshrc
+```
+
+You may of course also pipe the output of `npm completion` to a file
+such as `/usr/local/etc/bash_completion.d/npm` or
+`/etc/bash_completion.d/npm` if you have a system that will read
+that file for you.
+
+When `COMP_CWORD`, `COMP_LINE`, and `COMP_POINT` are defined in the
+environment, `npm completion` acts in "plumbing mode", and outputs
+completions based on the arguments.
+
+### See Also
+
+* [npm developers](/using-npm/developers)
+* [npm](/cli-commands/npm)