summaryrefslogtreecommitdiff
path: root/deps/npm/doc/cli/completion.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/doc/cli/completion.md')
-rw-r--r--deps/npm/doc/cli/completion.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/deps/npm/doc/cli/completion.md b/deps/npm/doc/cli/completion.md
new file mode 100644
index 0000000000..48bc50fd87
--- /dev/null
+++ b/deps/npm/doc/cli/completion.md
@@ -0,0 +1,29 @@
+npm-completion(1) -- Tab Completion for npm
+===========================================
+
+## SYNOPSIS
+
+ . <(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.
+
+You may of course also pipe the output of npm completion to a file
+such as `/usr/local/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(1)
+* npm-faq(1)
+* npm(1)