bot/node_modules/npm/docs/content/commands/npm-star.md

72 lines
1.7 KiB
Markdown

---
title: npm-star
section: 1
description: Mark your favorite packages
---
### Synopsis
```bash
npm star [<pkg>...]
```
Note: This command is unaware of workspaces.
### Description
"Starring" a package means that you have some interest in it. It's
a vaguely positive way to show that you care.
It's a boolean thing. Starring repeatedly has no additional effect.
### More
There's also these extra commands to help you manage your favorite packages:
#### Unstar
You can also "unstar" a package using [`npm unstar`](/commands/npm-unstar)
"Unstarring" is the same thing, but in reverse.
#### Listing stars
You can see all your starred packages using [`npm stars`](/commands/npm-stars)
### Configuration
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
#### `registry`
* Default: "https://registry.npmjs.org/"
* Type: URL
The base URL of the npm registry.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
#### `unicode`
* Default: false on windows, true on mac/unix systems with a unicode locale,
as defined by the `LC_ALL`, `LC_CTYPE`, or `LANG` environment variables.
* Type: Boolean
When set to true, npm uses unicode characters in the tree output. When
false, it uses ascii characters instead of unicode glyphs.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
### See Also
* [npm unstar](/commands/npm-unstar)
* [npm stars](/commands/npm-stars)
* [npm view](/commands/npm-view)
* [npm whoami](/commands/npm-whoami)
* [npm adduser](/commands/npm-adduser)