2024-12-05 23:24:47 +08:00
.TH "NPM-STAR" "1" "December 2024" "NPM@10.9.2" ""
2011-11-27 01:21:03 +08:00
.SH "NAME"
2022-12-07 11:18:33 +08:00
\fB npm-star\fR - Mark your favorite packages
.SS "Synopsis"
2014-09-25 05:41:07 +08:00
.P
.RS 2
2014-11-05 07:08:12 +08:00
.nf
2022-12-07 11:18:33 +08:00
npm star \[ lB]<package-spec>...\[ rB]
2014-11-05 07:08:12 +08:00
.fi
2014-09-25 05:41:07 +08:00
.RE
2021-03-24 02:58:11 +08:00
.P
2022-12-07 11:18:33 +08:00
Note: This command is unaware of workspaces.
.SS "Description"
2014-09-25 05:41:07 +08:00
.P
2022-12-07 11:18:33 +08:00
"Starring" a package means that you have some interest in it. It's a vaguely positive way to show that you care.
2011-11-27 01:21:03 +08:00
.P
2022-12-07 11:18:33 +08:00
It's a boolean thing. Starring repeatedly has no additional effect.
.SS "More"
2020-11-28 01:22:50 +08:00
.P
There's also these extra commands to help you manage your favorite packages:
2022-12-07 11:18:33 +08:00
.SS "Unstar"
2020-11-28 01:22:50 +08:00
.P
2022-11-08 02:02:05 +08:00
You can also "unstar" a package using npm help unstar
2020-11-28 01:22:50 +08:00
.P
2022-12-07 11:18:33 +08:00
"Unstarring" is the same thing, but in reverse.
.SS "Listing stars"
2011-11-27 01:21:03 +08:00
.P
2022-11-08 02:02:05 +08:00
You can see all your starred packages using npm help stars
2022-12-07 11:18:33 +08:00
.SS "Configuration"
.SS "\fBregistry\fR"
2021-05-21 03:54:50 +08:00
.RS 0
2022-12-07 11:18:33 +08:00
.IP \(bu 4
Default: "https://registry.npmjs.org/"
.IP \(bu 4
2021-05-21 03:54:50 +08:00
Type: URL
2022-12-07 11:18:33 +08:00
.RE 0
2021-05-21 03:54:50 +08:00
.P
2022-12-07 11:18:33 +08:00
The base URL of the npm registry.
.SS "\fBunicode\fR"
2021-05-21 03:54:50 +08:00
.RS 0
2022-12-07 11:18:33 +08:00
.IP \(bu 4
Default: false on windows, true on mac/unix systems with a unicode locale, as defined by the \fB LC_ALL\fR , \fB LC_CTYPE\fR , or \fB LANG\fR environment variables.
.IP \(bu 4
2021-05-21 03:54:50 +08:00
Type: Boolean
2022-12-07 11:18:33 +08:00
.RE 0
2021-05-21 03:54:50 +08:00
.P
2022-12-07 11:18:33 +08:00
When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs.
.SS "\fBotp\fR"
2022-05-12 01:17:18 +08:00
.RS 0
2022-12-07 11:18:33 +08:00
.IP \(bu 4
2022-05-12 01:17:18 +08:00
Default: null
2022-12-07 11:18:33 +08:00
.IP \(bu 4
2022-05-12 01:17:18 +08:00
Type: null or String
2022-12-07 11:18:33 +08:00
.RE 0
2022-05-12 01:17:18 +08:00
.P
2022-12-07 11:18:33 +08:00
This is a one-time password from a two-factor authenticator. It's needed when publishing or changing package permissions with \fB npm access\fR .
2022-05-12 01:17:18 +08:00
.P
2022-12-07 11:18:33 +08:00
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.
.SS "See Also"
2014-09-25 05:41:07 +08:00
.RS 0
2022-12-07 11:18:33 +08:00
.IP \(bu 4
2022-11-08 02:02:05 +08:00
npm help "package spec"
2022-12-07 11:18:33 +08:00
.IP \(bu 4
2020-11-28 01:22:50 +08:00
npm help unstar
2022-12-07 11:18:33 +08:00
.IP \(bu 4
2020-11-28 01:22:50 +08:00
npm help stars
2022-12-07 11:18:33 +08:00
.IP \(bu 4
2019-11-19 03:01:39 +08:00
npm help view
2022-12-07 11:18:33 +08:00
.IP \(bu 4
2019-11-19 03:01:39 +08:00
npm help whoami
2022-12-07 11:18:33 +08:00
.IP \(bu 4
2019-11-19 03:01:39 +08:00
npm help adduser
2022-12-07 11:18:33 +08:00
.RE 0