npm Services

• npm Orgs - the npm Orgs documentation site
• npm Enterprise - the npm Enterprise documentation site

Getting started

• 01 - What is npm?
• 02 - How to find & select packages
• 03 - How to set up a new npm account & install npm
• 04 - How to install local packages
• 05 - Working with package.json
• 06 - How to update local packages
• 07 - How to uninstall local packages
• 08 - How to install global packages
• 09 - How to update global packages
• 10 - How to uninstall global packages
• 11 - How to create Node.js modules
• 12 - How to publish & update a package
• 13 - How to use semantic versioning
• 14 - How to work with scoped packages
• 15 - How to label packages with dist-tags
• 16 - How to use two-factor authentication
• 17 - How to work with security tokens
• 18 - How to change profile settings
• 19 - Understanding packages and modules
• 20 - How to prevent permissions errors
• 21 - How to run a security audit with npm audit
• 22 - About audit reports

Private packages

• 01 - Working with private packages
• 02 - Downloading packages to CI/deployment servers
• 03 - Docker and private packages

Troubleshooting

• 01 - Try the latest stable version of node
• 02 - Try the latest stable version of npm
• 03 - If your npm is broken
• 04 - Try clearing the npm cache
• 05 - Common Errors

Using npm

• coding-style npm's "funny" coding style
• config More than you probably want to know about npm configuration
• developers Developer Guide
• disputes Handling Module Name Disputes
• orgs Working with Teams & Orgs
• registry The JavaScript Package Registry
• removing-npm Cleaning the Slate
• scope Scoped packages
• scripts How npm handles the "scripts" field
• semver The semantic versioner for npm

CLI commands

• access Set access level on published packages
• adduser Add a registry user account
• audit Run a security audit
• bin Display npm bin folder
• bugs Bugs for a package in a web browser maybe
• build Build a package
• bundle REMOVED
• cache Manipulates packages cache
• ci Install a project with a clean slate
• completion Tab Completion for npm
• config Manage the npm configuration files
• dedupe Reduce duplication
• deprecate Deprecate a version of a package
• dist-tag Modify package distribution tags
• docs Docs for a package in a web browser maybe
• doctor Check your environments
• edit Edit an installed package
• explore Browse an installed package
• help Get help on npm
• help-search Search npm help documentation
• hook Manage registry hooks
• init create a package.json file
• install Install a package
• install-ci-test
• install-test
• link Symlink a package folder
• logout Log out of the registry
• ls List installed packages
• npm javascript package manager
• outdated Check for outdated packages
• owner Manage package owners
• pack Create a tarball from a package
• ping Ping npm registry
• prefix Display prefix
• profile Change settings on your registry profile
• prune Remove extraneous packages
• publish Publish a package
• rebuild Rebuild a package
• repo Open package repository page in the browser
• restart Restart a package
• root Display npm root
• run-script Run arbitrary package scripts
• search Search for packages
• shrinkwrap Lock down dependency versions for publication
• star Mark your favorite packages
• stars View packages marked as favorites
• start Start a package
• stop Stop a package
• team Manage organization teams and team memberships
• test Test a package
• token Manage your authentication tokens
• uninstall Remove a package
• unpublish Remove a package from the registry
• update Update a package
• version Bump a package version
• view View registry info
• whoami Display npm username

Configuring npm

• folders Folder Structures Used by npm
• npmrc The npm config files
• package-lock.json A manifestation of the manifest
• package-locks An explanation of npm lockfiles
• package.json Specifics of npm's package.json handling
• shrinkwrap.json A publishable lockfile

View All On One Page