npm-completion.1 1010 B

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. .TH "NPM\-COMPLETION" "1" "October 2021" "" ""
  2. .SH "NAME"
  3. \fBnpm-completion\fR \- Tab Completion for npm
  4. .SS Synopsis
  5. .P
  6. .RS 2
  7. .nf
  8. source <(npm completion)
  9. .fi
  10. .RE
  11. .P
  12. Note: This command is unaware of workspaces\.
  13. .SS Description
  14. .P
  15. Enables tab\-completion in all npm commands\.
  16. .P
  17. The synopsis above
  18. loads the completions into your current shell\. Adding it to
  19. your ~/\.bashrc or ~/\.zshrc will make the completions available
  20. everywhere:
  21. .P
  22. .RS 2
  23. .nf
  24. npm completion >> ~/\.bashrc
  25. npm completion >> ~/\.zshrc
  26. .fi
  27. .RE
  28. .P
  29. You may of course also pipe the output of \fBnpm completion\fP to a file
  30. such as \fB/usr/local/etc/bash_completion\.d/npm\fP or
  31. \fB/etc/bash_completion\.d/npm\fP if you have a system that will read
  32. that file for you\.
  33. .P
  34. When \fBCOMP_CWORD\fP, \fBCOMP_LINE\fP, and \fBCOMP_POINT\fP are defined in the
  35. environment, \fBnpm completion\fP acts in "plumbing mode", and outputs
  36. completions based on the arguments\.
  37. .SS See Also
  38. .RS 0
  39. .IP \(bu 2
  40. npm help developers
  41. .IP \(bu 2
  42. npm help npm
  43. .RE