LinuxCommandLibrary

npm-star

Star and unstar npm packages

TLDR

Star a public package from the default registry

$ npm star [package_name]
copy

Star a package within a specific scope
$ npm star @[scope]/[package_name]
copy

Star a package from a specific registry
$ npm star [package_name] --registry [registry_url]
copy

Star a private package that requires authentication
$ npm star [package_name] --auth-type [legacy|oauth|web|saml]
copy

Star a package by providing an OTP for two-factor authentication
$ npm star [package_name] --otp [otp]
copy

Star a package with detailed logging
$ npm star [package_name] --loglevel verbose
copy

List all your starred packages
$ npm star --list
copy

List your starred packages from a specific registry
$ npm star --list --registry [registry_url]
copy

SYNOPSIS

npm star [package-spec...]
npm unstar [package-spec...]
npm star

PARAMETERS

--json
    Output data in JSON format.

--long
    Display extended information when listing starred packages.

--parseable
    Output data in a parseable format, suitable for scripts.

--otp
    Provide a one-time password for two-factor authentication.

--registry
    Specify the npm registry to use for the operation.

--dry-run
    Simulate the command without making actual changes.

--loglevel
    Set the level of logging output (e.g., silent, warn, info, debug).

--silent, -s
    Suppress all output messages.

--quiet, -q
    Suppress all output except warnings and errors.

--workspace
    Execute command in a specific workspace within a monorepo.

--workspaces, -ws
    Execute command in all configured workspaces.

--include-workspace-root
    Include the workspace root when executing in all workspaces.

--help, -h
    Display help information for the command.

DESCRIPTION

The npm star command allows users to publicly "star" npm packages they find useful or interesting. This action adds the package to the user's list of starred packages, visible on their npm profile. It also contributes to the package's overall popularity and visibility within the npm registry, potentially influencing search results and community recommendations. The command can also be used to "unstar" a previously starred package or, when invoked without arguments, to display a list of all packages the current user has starred. Starring is a simple yet effective way for the community to show appreciation and discover popular modules.

CAVEATS

Starring or unstarring a package requires you to be authenticated and logged into the npm registry. The action of starring is public and visible on your npm profile and the package's official page.

PUBLIC VISIBILITY

When you star a package, this action is publicly associated with your npm profile. This information is visible to others and contributes to the package's overall popularity count displayed on the npm registry.

COMMUNITY DISCOVERY

Stars play a role in the npm ecosystem by helping other users discover popular or highly regarded packages. Higher star counts can influence search results and make packages more prominent in community-curated lists.

HISTORY

The ability to star npm packages has been a core feature of the npm registry and CLI since its early days. It was designed to foster community engagement and provide a mechanism for users to express appreciation and track favorite modules. It has remained a consistent feature across npm versions, playing a role in community-driven package discovery.

SEE ALSO

npm unstar(1), npm view(1), npm search(1), npm profile(1), npm(1)

Copied to clipboard