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
Using
Config
config
More than you probably want to know about npm configuration
Select CLI Version:
Version 11.6.0 (Latest)
See Details
Table of contents
Description
Command Line Flags
Environment Variables
npmrc Files
Default Configs
Shorthands and Other CLI Niceties
Config Settings
_auth
access
all
allow-same-version
audit
audit-level
auth-type
before
bin-links
browser
ca
cache
cafile
call
cidr
color
commit-hooks
cpu
depth
description
diff
diff-dst-prefix
diff-ignore-all-space
diff-name-only
diff-no-prefix
diff-src-prefix
diff-text
diff-unified
dry-run
editor
engine-strict
expect-result-count
expect-results
fetch-retries
fetch-retry-factor
fetch-retry-maxtimeout
fetch-retry-mintimeout
fetch-timeout
force
foreground-scripts
format-package-lock
fund
git
git-tag-version
global
globalconfig
heading
https-proxy
if-present
ignore-scripts
include
include-staged
include-workspace-root
init-author-email
init-author-name
init-author-url
init-license
init-module
init-private
init-type
init-version
install-links
install-strategy
json
legacy-peer-deps
libc
link
local-address
location
lockfile-version
loglevel
logs-dir
logs-max
long
maxsockets
message
node-gyp
node-options
noproxy
offline
omit
omit-lockfile-registry-resolved
os
otp
pack-destination
package
package-lock
package-lock-only
parseable
prefer-dedupe
prefer-offline
prefer-online
prefix
preid
progress
provenance
provenance-file
proxy
read-only
rebuild-bundle
registry
replace-registry-host
save
save-bundle
save-dev
save-exact
save-optional
save-peer
save-prefix
save-prod
sbom-format
sbom-type
scope
script-shell
searchexclude
searchlimit
searchopts
searchstaleness
shell
sign-git-commit
sign-git-tag
strict-peer-deps
strict-ssl
tag
tag-version-prefix
timing
umask
unicode
update-notifier
usage
user-agent
userconfig
version
versions
viewer
which
workspace
workspaces
workspaces-update
yes
also
cache-max
cache-min
cert
dev
global-style
init.author.email
init.author.name
init.author.url
init.license