npm-star.1 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. .TH "NPM-STAR" "1" "March 2026" "NPM@11.12.0" ""
  2. .SH "NAME"
  3. \fBnpm-star\fR - Mark your favorite packages
  4. .SS "Synopsis"
  5. .P
  6. .RS 2
  7. .nf
  8. npm star \[lB]<package-spec>...\[rB]
  9. .fi
  10. .RE
  11. .P
  12. Note: This command is unaware of workspaces.
  13. .SS "Description"
  14. .P
  15. "Starring" a package means that you have some interest in it. It's a vaguely positive way to show that you care.
  16. .P
  17. It's a boolean thing. Starring repeatedly has no additional effect.
  18. .SS "More"
  19. .P
  20. There's also these extra commands to help you manage your favorite packages:
  21. .SS "Unstar"
  22. .P
  23. You can also "unstar" a package using npm help unstar
  24. .P
  25. "Unstarring" is the same thing, but in reverse.
  26. .SS "Listing stars"
  27. .P
  28. You can see all your starred packages using npm help stars
  29. .SS "Configuration"
  30. .SS "\fBregistry\fR"
  31. .RS 0
  32. .IP \(bu 4
  33. Default: "https://registry.npmjs.org/"
  34. .IP \(bu 4
  35. Type: URL
  36. .RE 0
  37. .P
  38. The base URL of the npm registry.
  39. .SS "\fBunicode\fR"
  40. .RS 0
  41. .IP \(bu 4
  42. Default: false on windows, true on mac/unix systems with a unicode locale, as defined by the \fBLC_ALL\fR, \fBLC_CTYPE\fR, or \fBLANG\fR environment variables.
  43. .IP \(bu 4
  44. Type: Boolean
  45. .RE 0
  46. .P
  47. When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs.
  48. .SS "\fBotp\fR"
  49. .RS 0
  50. .IP \(bu 4
  51. Default: null
  52. .IP \(bu 4
  53. Type: null or String
  54. .RE 0
  55. .P
  56. This is a one-time password from a two-factor authenticator. It's needed when publishing or changing package permissions with \fBnpm access\fR.
  57. .P
  58. If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one.
  59. .SS "See Also"
  60. .RS 0
  61. .IP \(bu 4
  62. npm help "package spec"
  63. .IP \(bu 4
  64. npm help unstar
  65. .IP \(bu 4
  66. npm help stars
  67. .IP \(bu 4
  68. npm help view
  69. .IP \(bu 4
  70. npm help whoami
  71. .IP \(bu 4
  72. npm help adduser
  73. .RE 0