Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEdward Thomson <ethomson@edwardthomson.com>2020-09-21 15:52:45 +0300
committerisaacs <i@izs.me>2020-10-23 20:23:01 +0300
commit09ca74cb6f90de0601a66b7ca2229828658ae8b8 (patch)
tree378829b4f2f42f235e6cd2d6b893535d1b3dc949 /docs/content/commands/npm-completion.md
parent70e211aae0d7a2217af8ecb348fda1257a938c8b (diff)
docs: use commands not cli-commands
Avoid needless and unnecessary redundancy.
Diffstat (limited to 'docs/content/commands/npm-completion.md')
-rw-r--r--docs/content/commands/npm-completion.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/content/commands/npm-completion.md b/docs/content/commands/npm-completion.md
new file mode 100644
index 000000000..284c4635c
--- /dev/null
+++ b/docs/content/commands/npm-completion.md
@@ -0,0 +1,39 @@
+---
+title: npm-completion
+section: 1
+description: 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)