npm-help.1 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. .TH "NPM-HELP" "1" "March 2026" "NPM@11.12.0" ""
  2. .SH "NAME"
  3. \fBnpm-help\fR - Get help on npm
  4. .SS "Synopsis"
  5. .P
  6. .RS 2
  7. .nf
  8. npm help <term> \[lB]<terms..>\[rB]
  9. alias: hlep
  10. .fi
  11. .RE
  12. .P
  13. Note: This command is unaware of workspaces.
  14. .SS "Description"
  15. .P
  16. If supplied a topic, then show the appropriate documentation page.
  17. .P
  18. If the topic does not exist, or if multiple terms are provided, then npm will run the \fBhelp-search\fR command to find a match. Note that, if \fBhelp-search\fR finds a single subject, then it will run \fBhelp\fR on that topic, so unique matches are equivalent to specifying a topic name.
  19. .SS "Configuration"
  20. .SS "\fBviewer\fR"
  21. .RS 0
  22. .IP \(bu 4
  23. Default: "man" on Posix, "browser" on Windows
  24. .IP \(bu 4
  25. Type: String
  26. .RE 0
  27. .P
  28. The program to use to view help content.
  29. .P
  30. Set to \fB"browser"\fR to view html help content in the default web browser.
  31. .SS "See Also"
  32. .RS 0
  33. .IP \(bu 4
  34. npm help npm
  35. .IP \(bu 4
  36. npm help folders
  37. .IP \(bu 4
  38. npm help config
  39. .IP \(bu 4
  40. npm help npmrc
  41. .IP \(bu 4
  42. \fBpackage.json\fR \fI\(la/configuring-npm/package-json\(ra\fR
  43. .IP \(bu 4
  44. npm help help-search
  45. .RE 0