npm-star.1 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. .TH "NPM\-STAR" "1" "October 2021" "" ""
  2. .SH "NAME"
  3. \fBnpm-star\fR \- Mark your favorite packages
  4. .SS Synopsis
  5. .P
  6. .RS 2
  7. .nf
  8. npm star [<pkg>\.\.\.]
  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
  16. a vaguely positive way to show that you care\.
  17. .P
  18. It's a boolean thing\. Starring repeatedly has no additional effect\.
  19. .SS More
  20. .P
  21. There's also these extra commands to help you manage your favorite packages:
  22. .SS Unstar
  23. .P
  24. You can also "unstar" a package using npm help \fBunstar\fP
  25. .P
  26. "Unstarring" is the same thing, but in reverse\.
  27. .SS Listing stars
  28. .P
  29. You can see all your starred packages using npm help \fBstars\fP
  30. .SS Configuration
  31. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS START \-\->
  32. <!\-\- automatically generated, do not edit manually \-\->
  33. <!\-\- see lib/utils/config/definitions\.js \-\->
  34. .SS \fBregistry\fP
  35. .RS 0
  36. .IP \(bu 2
  37. Default: "https://registry\.npmjs\.org/"
  38. .IP \(bu 2
  39. Type: URL
  40. .RE
  41. .P
  42. The base URL of the npm registry\.
  43. <!\-\- automatically generated, do not edit manually \-\->
  44. <!\-\- see lib/utils/config/definitions\.js \-\->
  45. .SS \fBunicode\fP
  46. .RS 0
  47. .IP \(bu 2
  48. Default: false on windows, true on mac/unix systems with a unicode locale,
  49. as defined by the \fBLC_ALL\fP, \fBLC_CTYPE\fP, or \fBLANG\fP environment variables\.
  50. .IP \(bu 2
  51. Type: Boolean
  52. .RE
  53. .P
  54. When set to true, npm uses unicode characters in the tree output\. When
  55. false, it uses ascii characters instead of unicode glyphs\.
  56. <!\-\- automatically generated, do not edit manually \-\->
  57. <!\-\- see lib/utils/config/definitions\.js \-\->
  58. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS END \-\->
  59. .SS See Also
  60. .RS 0
  61. .IP \(bu 2
  62. npm help unstar
  63. .IP \(bu 2
  64. npm help stars
  65. .IP \(bu 2
  66. npm help view
  67. .IP \(bu 2
  68. npm help whoami
  69. .IP \(bu 2
  70. npm help adduser
  71. .RE