Skip to search
Skip to content
npm Docs
npmjs.com
Status
Support
Site navigation
About npm
Getting started
Setting up your npm user account
Creating a new user account on the public registry
Creating a strong password
Receiving a one-time password over email
About two-factor authentication
Configuring two-factor authentication
Accessing npm using two-factor authentication
Recovering your 2FA-enabled account
Managing your npm user account
Managing your profile settings
Changing your npm username
Deleting your npm user account
Requesting an export of your personal data
Paying for your npm user account
Upgrading to a paid user account plan
Viewing, downloading, and emailing receipts for your npm user account
Updating user account billing settings
Downgrading to a free user account plan
Configuring your local environment
About npm CLI versions
Downloading and installing Node.js and npm
Troubleshooting
Generating and locating npm-debug.log files
Common errors
Try the latest stable version of node
Try the latest stable version of npm
Packages and modules
Introduction to packages and modules
About the public npm registry
About packages and modules
About scopes
About public packages
About private packages
npm package scope, access level, and visibility
Contributing packages to the registry
Creating a package.json file
Creating Node.js modules
About package README files
Creating and publishing unscoped public packages
Creating and publishing scoped public packages
Creating and publishing private packages
Package name guidelines
Specifying dependencies and devDependencies in a package.json file
About semantic versioning
Adding dist-tags to packages
Updating and managing your published packages
Changing package visibility
Adding collaborators to private packages owned by a user account
Updating your published package version number
Deprecating and undeprecating packages or package versions
Transferring a package from a user account to another user account
Unpublishing packages from the registry
Getting packages from the registry
Searching for and choosing packages to download
Downloading and installing packages locally
Downloading and installing packages globally
Resolving EACCES permissions errors when installing packages globally
Updating packages downloaded from the registry
Using npm packages in your projects
Using deprecated packages
Uninstalling packages and dependencies
Securing your code
About audit reports
Auditing package dependencies for security vulnerabilities
Generating provenance statements
Trusted publishing with OIDC
About ECDSA registry signatures
Verifying ECDSA registry signatures
Requiring 2FA for package publishing and settings modification
Reporting malware in an npm package
Integrations
Integrating npm with external services
About access tokens
Creating and viewing access tokens
Revoking access tokens
Using private packages in a CI/CD workflow
Docker and private modules
Organizations
Creating and managing organizations
Creating an organization
Converting your user account to an organization
Requiring two-factor authentication in your organization
Renaming an organization
Deleting an organization
Paying for your organization
Upgrading to a paid organization plan
Viewing, downloading, and emailing receipts for your organization
Updating organization billing settings
Downgrading to a free organization plan
Managing organization members
Adding members to your organization
Accepting or rejecting an organization invitation
Organization roles and permissions
Managing organization permissions
Removing members from your organization
Managing teams
About the developers team
Creating teams
Adding organization members to teams
Removing organization members from teams
Managing team access to organization packages
Removing teams
Managing organization packages
About organization scopes and packages
Configuring your npm client with your organization settings
Creating and publishing an organization scoped package
Policies
Terms of Use
Open Source Terms
Private Terms
Code of Conduct
Package Name Disputes
npm License
Privacy Policy
Unpublish Policy
Copyright and DMCA Policy
Logos and Usage
Security
Replication and web crawler policy
Threats and mitigations
npm CLI
CLI Commands
npm
npm access
npm adduser
npm audit
npm bugs
npm cache
npm ci
npm completion
npm config
npm dedupe
npm deprecate
npm diff
npm dist-tag
npm docs
npm doctor
npm edit
npm exec
npm explain
npm explore
npm find-dupes
npm fund
npm help
npm help-search
npm init
npm install
npm install-ci-test
npm install-test
npm link
npm login
npm logout
npm ls
npm org
npm outdated
npm owner
npm pack
npm ping
npm pkg
npm prefix
npm profile
npm prune
npm publish
npm query
npm rebuild
npm repo
npm restart
npm root
npm run
npm sbom
npm search
npm shrinkwrap
npm star
npm stars
npm start
npm stop
npm team
npm test
npm token
npm undeprecate
npm uninstall
npm unpublish
npm unstar
npm update
npm version
npm view
npm whoami
npx
Configuring npm
Install
Folders
.npmrc
npm-shrinkwrap.json
package.json
package-lock.json
Using npm
Registry
Package spec
Config
Logging
Scope
Scripts
Workspaces
Organizations
Dependency Selectors
Developers
Removal
Changelog
npmjs.com
Status
Support
GitHub
CLI
Commands
CLI Commands
Select CLI Version:
Version 11.7.0 (Latest)
npm
JavaScript package manager
npm access
Set access level on published packages
npm adduser
Add a registry user account
npm audit
Run a security audit
npm bugs
Bugs for a package in a web browser maybe
npm cache
Manipulates packages cache
npm ci
Install a project with a clean slate
npm completion
Tab completion for npm
npm config
Manage the npm configuration files
npm dedupe
Reduce duplication
npm deprecate
Deprecate a version of a package
npm diff
The registry diff command
npm dist-tag
Modify package distribution tags
npm docs
Docs for a package in a web browser maybe
npm doctor
Check your environments
npm edit
Edit an installed package
npm exec
Run a command from an npm package
npm explain
Explain installed packages
npm explore
Browse an installed package
npm find-dupes
Find duplication in the package tree
npm fund
Retrieve funding information
npm help
Search npm help documentation
npm help-search
Get help on npm
npm init
Create a package.json file
npm install
Install a package
npm install-ci-test
Install a project with a clean slate and run tests
npm install-test
Install package(s) and run tests
npm link
Symlink a package folder
npm login
Login to a registry user account
npm logout
Log out of the registry
npm ls
List installed packages
npm org
Manage orgs
npm outdated
Check for outdated packages
npm owner
Manage package owners
npm pack
Create a tarball from a package
npm ping
Ping npm registry
npm pkg
Manages your package.json
npm prefix
Display prefix
npm profile
Change settings on your registry profile
npm prune
Remove extraneous packages
npm publish
Publish a package
npm query
Retrieve a filtered list of packages
npm rebuild
Rebuild a package
npm repo
Open package repository page in the browser
npm restart
Restart a package
npm root
Display npm root
npm run
Run arbitrary package scripts
npm sbom
Generate a Software Bill of Materials (SBOM)
npm search
Search for packages
npm shrinkwrap
Lock down dependency versions for publication
npm star
Mark your favorite packages
npm stars
View packages marked as favorites
npm start
Start a package
npm stop
Stop a package
npm team
Manage organization teams and team memberships
npm test
Test a package
npm token
Manage your authentication tokens
npm undeprecate
Undeprecate a version of a package
npm uninstall
Remove a package
npm unpublish
Remove a package from the registry
npm unstar
Remove an item from your favorite packages
npm update
Update a package
npm version
Bump a package version
npm view
View registry info
npm whoami
Display npm username
npx
Run a command from an npm package