1 # For registry content, edit this file.
2 # The CLI content in this file is automatically generated. Do not edit.
3 # For CLI content, edit `docs/nav.yml` in https://github.com/npm/cli.
4
5 - title: About npm
6 url: /about-npm
7 - title: Getting started
8 url: /getting-started
9 children:
10 - title: Setting up your npm user account
11 shortName: Setting up your account
12 url: /getting-started/setting-up-your-npm-user-account
13 children:
14 - title: Creating a new user account on the public registry
15 url: /creating-a-new-npm-user-account
16 - title: Creating a strong password
17 url: /creating-a-strong-password
18 - title: Receiving a one-time password over email
19 url: /receiving-a-one-time-password-over-email
20 - title: About two-factor authentication
21 url: /about-two-factor-authentication
22 - title: Configuring two-factor authentication
23 url: /configuring-two-factor-authentication
24 - title: Accessing npm using two-factor authentication
25 url: /accessing-npm-using-2fa
26 - title: Recovering your 2FA-enabled account
27 url: /recovering-your-2fa-enabled-account
28 - title: Managing your npm user account
29 shortName: Managing your account
30 url: /getting-started/managing-your-npm-user-account
31 children:
32 - title: Managing your profile settings
33 url: /managing-your-profile-settings
34 - title: Changing your npm username
35 url: /changing-your-npm-username
36 - title: Deleting your npm user account
37 url: /deleting-your-npm-user-account
38 - title: Requesting an export of your personal data
39 url: /requesting-your-data
40 - title: Paying for your npm user account
41 shortName: Paying for your account
42 url: /getting-started/paying-for-your-npm-user-account
43 children:
44 - title: Upgrading to a paid user account plan
45 url: /upgrading-to-a-paid-user-account-plan
46 - title: Viewing, downloading, and emailing receipts for your npm user account
47 url: /viewing-downloading-and-emailing-receipts-for-your-user-account
48 - title: Updating user account billing settings
49 url: /updating-user-account-billing-settings
50 - title: Downgrading to a free user account plan
51 url: /downgrading-to-a-free-user-account-plan
52 - title: Configuring your local environment
53 shortName: Configuring
54 url: /getting-started/configuring-your-local-environment
55 children:
56 - title: About npm CLI versions
57 url: /about-npm-versions
58 - title: Downloading and installing Node.js and npm
59 url: /downloading-and-installing-node-js-and-npm
60 - title: Troubleshooting
61 url: /getting-started/troubleshooting
62 children:
63 - title: Generating and locating npm-debug.log files
64 url: /generating-and-locating-npm-debug.log-files
65 - title: Common errors
66 url: /common-errors
67 - title: Try the latest stable version of node
68 url: /try-the-latest-stable-version-of-node
69 - title: Try the latest stable version of npm
70 url: /try-the-latest-stable-version-of-npm
71 - title: Packages and modules
72 url: /packages-and-modules
73 children:
74 - title: Introduction to packages and modules
75 shortName: Introduction
76 url: /packages-and-modules/introduction-to-packages-and-modules
77 children:
78 - title: About the public npm registry
79 url: /about-the-public-npm-registry
80 - title: About packages and modules
81 url: /about-packages-and-modules
82 - title: About scopes
83 url: /about-scopes
84 - title: About public packages
85 url: /about-public-packages
86 - title: About private packages
87 url: /about-private-packages
88 - title: npm package scope, access level, and visibility
89 url: /package-scope-access-level-and-visibility
90 - title: Contributing packages to the registry
91 shortName: Contributing
92 url: /packages-and-modules/contributing-packages-to-the-registry
93 children:
94 - title: Creating a package.json file
95 url: /creating-a-package-json-file
96 - title: Creating Node.js modules
97 url: /creating-node-js-modules
98 - title: About package README files
99 url: /about-package-readme-files
100 - title: Creating and publishing unscoped public packages
101 url: /creating-and-publishing-unscoped-public-packages
102 - title: Creating and publishing scoped public packages
103 url: /creating-and-publishing-scoped-public-packages
104 - title: Creating and publishing private packages
105 url: /creating-and-publishing-private-packages
106 - title: Package name guidelines
107 url: /package-name-guidelines
108 - title: Specifying dependencies and devDependencies in a package.json file
109 url: /specifying-dependencies-and-devdependencies-in-a-package-json-file
110 - title: About semantic versioning
111 url: /about-semantic-versioning
112 - title: Adding dist-tags to packages
113 url: /adding-dist-tags-to-packages
114 - title: Updating and managing your published packages
115 shortName: Updating and managing
116 url: /packages-and-modules/updating-and-managing-your-published-packages
117 children:
118 - title: Changing package visibility
119 url: /changing-package-visibility
120 - title: Adding collaborators to private packages owned by a user account
121 url: /adding-collaborators-to-private-packages-owned-by-a-user-account
122 - title: Updating your published package version number
123 url: /updating-your-published-package-version-number
124 - title: Deprecating and undeprecating packages or package versions
125 url: /deprecating-and-undeprecating-packages-or-package-versions
126 - title: Transferring a package from a user account to another user account
127 url: /transferring-a-package-from-a-user-account-to-another-user-account
128 - title: Unpublishing packages from the registry
129 url: /unpublishing-packages-from-the-registry
130 - title: Getting packages from the registry
131 shortName: Getting packages
132 url: /packages-and-modules/getting-packages-from-the-registry
133 children:
134 - title: Searching for and choosing packages to download
135 url: /searching-for-and-choosing-packages-to-download
136 - title: Downloading and installing packages locally
137 url: /downloading-and-installing-packages-locally
138 - title: Downloading and installing packages globally
139 url: /downloading-and-installing-packages-globally
140 - title: Resolving EACCES permissions errors when installing packages globally
141 url: /resolving-eacces-permissions-errors-when-installing-packages-globally
142 - title: Updating packages downloaded from the registry
143 url: /updating-packages-downloaded-from-the-registry
144 - title: Using npm packages in your projects
145 url: /using-npm-packages-in-your-projects
146 - title: Using deprecated packages
147 url: /using-deprecated-packages
148 - title: Uninstalling packages and dependencies
149 url: /uninstalling-packages-and-dependencies
150 - title: Securing your code
151 url: /packages-and-modules/securing-your-code
152 children:
153 - title: About audit reports
154 url: /about-audit-reports
155 - title: Auditing package dependencies for security vulnerabilities
156 url: /auditing-package-dependencies-for-security-vulnerabilities
157 - title: Generating provenance statements
158 url: /generating-provenance-statements
159 - title: Trusted publishing with OIDC
160 url: /trusted-publishers
161 - title: Staged publishing
162 url: /staged-publishing
163 - title: About ECDSA registry signatures
164 url: /about-registry-signatures
165 - title: Verifying ECDSA registry signatures
166 url: /verifying-registry-signatures
167 - title: Requiring 2FA for package publishing and settings modification
168 url: /requiring-2fa-for-package-publishing-and-settings-modification
169 - title: Reporting malware in an npm package
170 url: /reporting-malware-in-an-npm-package
171 - title: Integrations
172 url: /integrations
173 children:
174 - title: Integrating npm with external services
175 shortName: Integrating with external services
176 url: /integrations/integrating-npm-with-external-services
177 children:
178 - title: About access tokens
179 url: /about-access-tokens
180 - title: Creating and viewing access tokens
181 url: /creating-and-viewing-access-tokens
182 - title: Revoking access tokens
183 url: /revoking-access-tokens
184 - title: Using private packages in a CI/CD workflow
185 url: /using-private-packages-in-a-ci-cd-workflow
186 - title: Docker and private modules
187 url: /docker-and-private-modules
188 - title: Organizations
189 url: /organizations
190 children:
191 - title: Creating and managing organizations
192 shortName: Creating
193 url: /organizations/creating-and-managing-organizations
194 children:
195 - title: Creating an organization
196 url: /creating-an-organization
197 - title: Converting your user account to an organization
198 url: /converting-your-user-account-to-an-organization
199 - title: Requiring two-factor authentication in your organization
200 url: /requiring-two-factor-authentication-in-your-organization
201 - title: Renaming an organization
202 url: /renaming-an-organization
203 - title: Deleting an organization
204 url: /deleting-an-organization
205 - title: Paying for your organization
206 shortName: Paying
207 url: /organizations/paying-for-your-organization
208 children:
209 - title: Upgrading to a paid organization plan
210 url: /upgrading-to-a-paid-organization-plan
211 - title: Viewing, downloading, and emailing receipts for your organization
212 url: /viewing-downloading-and-emailing-receipts-for-your-organization
213 - title: Updating organization billing settings
214 url: /updating-organization-billing-settings
215 - title: Downgrading to a free organization plan
216 url: /downgrading-to-a-free-organization-plan
217 - title: Managing organization members
218 shortName: Managing members
219 url: /organizations/managing-organization-members
220 children:
221 - title: Adding members to your organization
222 url: /adding-members-to-your-organization
223 - title: Accepting or rejecting an organization invitation
224 url: /accepting-or-rejecting-an-organization-invitation
225 - title: Organization roles and permissions
226 url: /organization-roles-and-permissions
227 - title: Managing organization permissions
228 url: /managing-organization-permissions
229 - title: Removing members from your organization
230 url: /removing-members-from-your-organization
231 - title: Managing teams
232 url: /organizations/managing-teams
233 children:
234 - title: About the developers team
235 url: /about-developers-team
236 - title: Creating teams
237 url: /creating-teams
238 - title: Adding organization members to teams
239 url: /adding-organization-members-to-teams
240 - title: Removing organization members from teams
241 url: /removing-organization-members-from-teams
242 - title: Managing team access to organization packages
243 url: /managing-team-access-to-organization-packages
244 - title: Removing teams
245 url: /removing-teams
246 - title: Managing organization packages
247 shortName: Managing packages
248 url: /organizations/managing-organization-packages
249 children:
250 - title: About organization scopes and packages
251 url: /about-organization-scopes-and-packages
252 - title: Configuring your npm client with your organization settings
253 url: /configuring-your-npm-client-with-your-organization-settings
254 - title: Creating and publishing an organization scoped package
255 url: /creating-and-publishing-an-organization-scoped-package
256 - title: Policies
257 url: /policies
258 children:
259 - title: Terms of Use
260 url: /policies/terms
261 - title: Open Source Terms
262 url: /policies/open-source-terms
263 - title: Private Terms
264 url: /policies/private-terms
265 - title: Code of Conduct
266 url: /policies/conduct
267 - title: Package Name Disputes
268 url: /policies/disputes
269 - title: npm License
270 url: /policies/npm-license
271 - title: Privacy Policy
272 url: /policies/privacy
273 - title: Unpublish Policy
274 url: /policies/unpublish
275 - title: Copyright and DMCA Policy
276 url: /policies/dmca
277 - title: Logos and Usage
278 url: /policies/logos-and-usage
279 - title: Security
280 url: /policies/security
281 - title: Replication and web crawler policy
282 url: /policies/crawlers
283 - title: Threats and mitigations
284 shortName: Threats and mitigations
285 url: /threats-and-mitigations
286 - title: npm CLI
287 shortName: CLI
288 url: /cli
289 variants:
290 - title: Version 6.14.18
291 shortName: v6
292 url: /cli/v6
293 default: false
294 type: legacy
295 children:
296 - title: CLI Commands
297 shortName: Commands
298 url: /cli/v6/commands
299 children:
300 - title: npm
301 url: /cli/v6/commands/npm
302 description: JavaScript package manager
303 - title: npm access
304 url: /cli/v6/commands/npm-access
305 description: Set access level on published packages
306 - title: npm adduser
307 url: /cli/v6/commands/npm-adduser
308 description: Add a registry user account
309 - title: npm audit
310 url: /cli/v6/commands/npm-audit
311 description: Run a security audit
312 - title: npm bin
313 url: /cli/v6/commands/npm-bin
314 description: Display npm bin folder
315 - title: npm bugs
316 url: /cli/v6/commands/npm-bugs
317 description: Bugs for a package in a web browser maybe
318 - title: npm build
319 url: /cli/v6/commands/npm-build
320 description: Build a package
321 - title: npm bundle
322 url: /cli/v6/commands/npm-bundle
323 description: Removed
324 - title: npm cache
325 url: /cli/v6/commands/npm-cache
326 description: Manipulates packages cache
327 - title: npm ci
328 url: /cli/v6/commands/npm-ci
329 description: Install a project with a clean slate
330 - title: npm completion
331 url: /cli/v6/commands/npm-completion
332 description: Tab completion for npm
333 - title: npm config
334 url: /cli/v6/commands/npm-config
335 description: Manage the npm configuration files
336 - title: npm dedupe
337 url: /cli/v6/commands/npm-dedupe
338 description: Reduce duplication
339 - title: npm deprecate
340 url: /cli/v6/commands/npm-deprecate
341 description: Deprecate a version of a package
342 - title: npm dist-tag
343 url: /cli/v6/commands/npm-dist-tag
344 description: Modify package distribution tags
345 - title: npm docs
346 url: /cli/v6/commands/npm-docs
347 description: Docs for a package in a web browser maybe
348 - title: npm doctor
349 url: /cli/v6/commands/npm-doctor
350 description: Check your environments
351 - title: npm edit
352 url: /cli/v6/commands/npm-edit
353 description: Edit an installed package
354 - title: npm explore
355 url: /cli/v6/commands/npm-explore
356 description: Browse an installed package
357 - title: npm fund
358 url: /cli/v6/commands/npm-fund
359 description: Retrieve funding information
360 - title: npm help
361 url: /cli/v6/commands/npm-help
362 description: Search npm help documentation
363 - title: npm help-search
364 url: /cli/v6/commands/npm-help-search
365 description: Get help on npm
366 - title: npm hook
367 url: /cli/v6/commands/npm-hook
368 description: Manage registry hooks
369 - title: npm init
370 url: /cli/v6/commands/npm-init
371 description: Create a package.json file
372 - title: npm install
373 url: /cli/v6/commands/npm-install
374 description: Install a package
375 - title: npm install-ci-test
376 url: /cli/v6/commands/npm-install-ci-test
377 description: Install a project with a clean slate and run tests
378 - title: npm install-test
379 url: /cli/v6/commands/npm-install-test
380 description: Install package(s) and run tests
381 - title: npm link
382 url: /cli/v6/commands/npm-link
383 description: Symlink a package folder
384 - title: npm logout
385 url: /cli/v6/commands/npm-logout
386 description: Log out of the registry
387 - title: npm ls
388 url: /cli/v6/commands/npm-ls
389 description: List installed packages
390 - title: npm org
391 url: /cli/v6/commands/npm-org
392 description: Manage orgs
393 - title: npm outdated
394 url: /cli/v6/commands/npm-outdated
395 description: Check for outdated packages
396 - title: npm owner
397 url: /cli/v6/commands/npm-owner
398 description: Manage package owners
399 - title: npm pack
400 url: /cli/v6/commands/npm-pack
401 description: Create a tarball from a package
402 - title: npm ping
403 url: /cli/v6/commands/npm-ping
404 description: Ping npm registry
405 - title: npm prefix
406 url: /cli/v6/commands/npm-prefix
407 description: Display prefix
408 - title: npm profile
409 url: /cli/v6/commands/npm-profile
410 description: Change settings on your registry profile
411 - title: npm prune
412 url: /cli/v6/commands/npm-prune
413 description: Remove extraneous packages
414 - title: npm publish
415 url: /cli/v6/commands/npm-publish
416 description: Publish a package
417 - title: npm rebuild
418 url: /cli/v6/commands/npm-rebuild
419 description: Rebuild a package
420 - title: npm repo
421 url: /cli/v6/commands/npm-repo
422 description: Open package repository page in the browser
423 - title: npm restart
424 url: /cli/v6/commands/npm-restart
425 description: Restart a package
426 - title: npm root
427 url: /cli/v6/commands/npm-root
428 description: Display npm root
429 - title: npm run-script
430 url: /cli/v6/commands/npm-run-script
431 description: Run arbitrary package scripts
432 - title: npm search
433 url: /cli/v6/commands/npm-search
434 description: Search for packages
435 - title: npm shrinkwrap
436 url: /cli/v6/commands/npm-shrinkwrap
437 description: Lock down dependency versions for publication
438 - title: npm star
439 url: /cli/v6/commands/npm-star
440 description: Mark your favorite packages
441 - title: npm stars
442 url: /cli/v6/commands/npm-stars
443 description: View packages marked as favorites
444 - title: npm start
445 url: /cli/v6/commands/npm-start
446 description: Start a package
447 - title: npm stop
448 url: /cli/v6/commands/npm-stop
449 description: Stop a package
450 - title: npm team
451 url: /cli/v6/commands/npm-team
452 description: Manage organization teams and team memberships
453 - title: npm test
454 url: /cli/v6/commands/npm-test
455 description: Test a package
456 - title: npm token
457 url: /cli/v6/commands/npm-token
458 description: Manage your authentication tokens
459 - title: npm uninstall
460 url: /cli/v6/commands/npm-uninstall
461 description: Remove a package
462 - title: npm unpublish
463 url: /cli/v6/commands/npm-unpublish
464 description: Remove a package from the registry
465 - title: npm update
466 url: /cli/v6/commands/npm-update
467 description: Update a package
468 - title: npm version
469 url: /cli/v6/commands/npm-version
470 description: Bump a package version
471 - title: npm view
472 url: /cli/v6/commands/npm-view
473 description: View registry info
474 - title: npm whoami
475 url: /cli/v6/commands/npm-whoami
476 description: Display npm username
477 - title: Configuring npm
478 shortName: Configuring
479 url: /cli/v6/configuring-npm
480 children:
481 - title: Install
482 url: /cli/v6/configuring-npm/install
483 description: Download and install node and npm
484 - title: Folders
485 url: /cli/v6/configuring-npm/folders
486 description: Folder structures used by npm
487 - title: .npmrc
488 url: /cli/v6/configuring-npm/npmrc
489 description: The npm config files
490 - title: package.json
491 url: /cli/v6/configuring-npm/package-json
492 description: Specifics of npm's package.json handling
493 - title: package-locks
494 url: /cli/v6/configuring-npm/package-locks
495 description: An explanation of npm lockfiles
496 - title: package-lock.json
497 url: /cli/v6/configuring-npm/package-lock-json
498 description: A manifestation of the manifest
499 - title: shrinkwrap.json
500 url: /cli/v6/configuring-npm/shrinkwrap-json
501 description: A publishable lockfile
502 - title: Using npm
503 shortName: Using
504 url: /cli/v6/using-npm
505 children:
506 - title: Registry
507 url: /cli/v6/using-npm/registry
508 description: The JavaScript Package Registry
509 - title: Config
510 url: /cli/v6/using-npm/config
511 description: About npm configuration
512 - title: semver
513 url: /cli/v6/using-npm/semver
514 description: The semantic versioner for npm
515 - title: Scope
516 url: /cli/v6/using-npm/scope
517 description: Scoped packages
518 - title: Scripts
519 url: /cli/v6/using-npm/scripts
520 description: How npm handles the "scripts" field
521 - title: Organizations
522 url: /cli/v6/using-npm/orgs
523 description: Working with teams & organizations
524 - title: Developers
525 url: /cli/v6/using-npm/developers
526 description: Developer guide
527 - title: Removal
528 url: /cli/v6/using-npm/removal
529 description: Cleaning the slate
530 - title: Changelog
531 url: /cli/v6/using-npm/changelog
532 description: Changelog notes for each version
533 - title: Version 7.24.2
534 shortName: v7
535 url: /cli/v7
536 default: false
537 type: legacy
538 children:
539 - title: CLI Commands
540 shortName: Commands
541 url: /cli/v7/commands
542 children:
543 - title: npm
544 url: /cli/v7/commands/npm
545 description: JavaScript package manager
546 - title: npm access
547 url: /cli/v7/commands/npm-access
548 description: Set access level on published packages
549 - title: npm adduser
550 url: /cli/v7/commands/npm-adduser
551 description: Add a registry user account
552 - title: npm audit
553 url: /cli/v7/commands/npm-audit
554 description: Run a security audit
555 - title: npm bin
556 url: /cli/v7/commands/npm-bin
557 description: Display npm bin folder
558 - title: npm bugs
559 url: /cli/v7/commands/npm-bugs
560 description: Bugs for a package in a web browser maybe
561 - title: npm cache
562 url: /cli/v7/commands/npm-cache
563 description: Manipulates packages cache
564 - title: npm ci
565 url: /cli/v7/commands/npm-ci
566 description: Install a project with a clean slate
567 - title: npm completion
568 url: /cli/v7/commands/npm-completion
569 description: Tab completion for npm
570 - title: npm config
571 url: /cli/v7/commands/npm-config
572 description: Manage the npm configuration files
573 - title: npm dedupe
574 url: /cli/v7/commands/npm-dedupe
575 description: Reduce duplication
576 - title: npm deprecate
577 url: /cli/v7/commands/npm-deprecate
578 description: Deprecate a version of a package
579 - title: npm diff
580 url: /cli/v7/commands/npm-diff
581 description: The registry diff command
582 - title: npm dist-tag
583 url: /cli/v7/commands/npm-dist-tag
584 description: Modify package distribution tags
585 - title: npm docs
586 url: /cli/v7/commands/npm-docs
587 description: Docs for a package in a web browser maybe
588 - title: npm doctor
589 url: /cli/v7/commands/npm-doctor
590 description: Check your environments
591 - title: npm edit
592 url: /cli/v7/commands/npm-edit
593 description: Edit an installed package
594 - title: npm exec
595 url: /cli/v7/commands/npm-exec
596 description: Run a command from an npm package
597 - title: npm explain
598 url: /cli/v7/commands/npm-explain
599 description: Explain installed packages
600 - title: npm explore
601 url: /cli/v7/commands/npm-explore
602 description: Browse an installed package
603 - title: npm find-dupes
604 url: /cli/v7/commands/npm-find-dupes
605 description: Find duplication in the package tree
606 - title: npm fund
607 url: /cli/v7/commands/npm-fund
608 description: Retrieve funding information
609 - title: npm help
610 url: /cli/v7/commands/npm-help
611 description: Search npm help documentation
612 - title: npm help-search
613 url: /cli/v7/commands/npm-help-search
614 description: Get help on npm
615 - title: npm hook
616 url: /cli/v7/commands/npm-hook
617 description: Manage registry hooks
618 - title: npm init
619 url: /cli/v7/commands/npm-init
620 description: Create a package.json file
621 - title: npm install
622 url: /cli/v7/commands/npm-install
623 description: Install a package
624 - title: npm install-ci-test
625 url: /cli/v7/commands/npm-install-ci-test
626 description: Install a project with a clean slate and run tests
627 - title: npm install-test
628 url: /cli/v7/commands/npm-install-test
629 description: Install package(s) and run tests
630 - title: npm link
631 url: /cli/v7/commands/npm-link
632 description: Symlink a package folder
633 - title: npm logout
634 url: /cli/v7/commands/npm-logout
635 description: Log out of the registry
636 - title: npm ls
637 url: /cli/v7/commands/npm-ls
638 description: List installed packages
639 - title: npm org
640 url: /cli/v7/commands/npm-org
641 description: Manage orgs
642 - title: npm outdated
643 url: /cli/v7/commands/npm-outdated
644 description: Check for outdated packages
645 - title: npm owner
646 url: /cli/v7/commands/npm-owner
647 description: Manage package owners
648 - title: npm pack
649 url: /cli/v7/commands/npm-pack
650 description: Create a tarball from a package
651 - title: npm ping
652 url: /cli/v7/commands/npm-ping
653 description: Ping npm registry
654 - title: npm pkg
655 url: /cli/v7/commands/npm-pkg
656 description: Manages your package.json
657 - title: npm prefix
658 url: /cli/v7/commands/npm-prefix
659 description: Display prefix
660 - title: npm profile
661 url: /cli/v7/commands/npm-profile
662 description: Change settings on your registry profile
663 - title: npm prune
664 url: /cli/v7/commands/npm-prune
665 description: Remove extraneous packages
666 - title: npm publish
667 url: /cli/v7/commands/npm-publish
668 description: Publish a package
669 - title: npm rebuild
670 url: /cli/v7/commands/npm-rebuild
671 description: Rebuild a package
672 - title: npm repo
673 url: /cli/v7/commands/npm-repo
674 description: Open package repository page in the browser
675 - title: npm restart
676 url: /cli/v7/commands/npm-restart
677 description: Restart a package
678 - title: npm root
679 url: /cli/v7/commands/npm-root
680 description: Display npm root
681 - title: npm run-script
682 url: /cli/v7/commands/npm-run-script
683 description: Run arbitrary package scripts
684 - title: npm search
685 url: /cli/v7/commands/npm-search
686 description: Search for packages
687 - title: npm set-script
688 url: /cli/v7/commands/npm-set-script
689 description: Set tasks in the scripts section of package.json
690 - title: npm shrinkwrap
691 url: /cli/v7/commands/npm-shrinkwrap
692 description: Lock down dependency versions for publication
693 - title: npm star
694 url: /cli/v7/commands/npm-star
695 description: Mark your favorite packages
696 - title: npm stars
697 url: /cli/v7/commands/npm-stars
698 description: View packages marked as favorites
699 - title: npm start
700 url: /cli/v7/commands/npm-start
701 description: Start a package
702 - title: npm stop
703 url: /cli/v7/commands/npm-stop
704 description: Stop a package
705 - title: npm team
706 url: /cli/v7/commands/npm-team
707 description: Manage organization teams and team memberships
708 - title: npm test
709 url: /cli/v7/commands/npm-test
710 description: Test a package
711 - title: npm token
712 url: /cli/v7/commands/npm-token
713 description: Manage your authentication tokens
714 - title: npm uninstall
715 url: /cli/v7/commands/npm-uninstall
716 description: Remove a package
717 - title: npm unpublish
718 url: /cli/v7/commands/npm-unpublish
719 description: Remove a package from the registry
720 - title: npm unstar
721 url: /cli/v7/commands/npm-unstar
722 description: Remove an item from your favorite packages
723 - title: npm update
724 url: /cli/v7/commands/npm-update
725 description: Update a package
726 - title: npm version
727 url: /cli/v7/commands/npm-version
728 description: Bump a package version
729 - title: npm view
730 url: /cli/v7/commands/npm-view
731 description: View registry info
732 - title: npm whoami
733 url: /cli/v7/commands/npm-whoami
734 description: Display npm username
735 - title: npx
736 url: /cli/v7/commands/npx
737 description: Run a command from an npm package
738 - title: Configuring npm
739 shortName: Configuring
740 url: /cli/v7/configuring-npm
741 children:
742 - title: Install
743 url: /cli/v7/configuring-npm/install
744 description: Download and install node and npm
745 - title: Folders
746 url: /cli/v7/configuring-npm/folders
747 description: Folder structures used by npm
748 - title: .npmrc
749 url: /cli/v7/configuring-npm/npmrc
750 description: The npm config files
751 - title: npm-shrinkwrap.json
752 url: /cli/v7/configuring-npm/npm-shrinkwrap-json
753 description: A publishable lockfile
754 - title: package.json
755 url: /cli/v7/configuring-npm/package-json
756 description: Specifics of npm's package.json handling
757 - title: package-lock.json
758 url: /cli/v7/configuring-npm/package-lock-json
759 description: A manifestation of the manifest
760 - title: Using npm
761 shortName: Using
762 url: /cli/v7/using-npm
763 children:
764 - title: Registry
765 url: /cli/v7/using-npm/registry
766 description: The JavaScript Package Registry
767 - title: Config
768 url: /cli/v7/using-npm/config
769 description: About npm configuration
770 - title: Scope
771 url: /cli/v7/using-npm/scope
772 description: Scoped packages
773 - title: Scripts
774 url: /cli/v7/using-npm/scripts
775 description: How npm handles the "scripts" field
776 - title: Workspaces
777 url: /cli/v7/using-npm/workspaces
778 description: Working with workspaces
779 - title: Organizations
780 url: /cli/v7/using-npm/orgs
781 description: Working with teams & organizations
782 - title: Developers
783 url: /cli/v7/using-npm/developers
784 description: Developer guide
785 - title: Removal
786 url: /cli/v7/using-npm/removal
787 description: Cleaning the slate
788 - title: Changelog
789 url: /cli/v7/using-npm/changelog
790 description: Changelog notes for each version
791 - title: Version 8.19.4
792 shortName: v8
793 url: /cli/v8
794 default: false
795 type: legacy
796 children:
797 - title: CLI Commands
798 shortName: Commands
799 url: /cli/v8/commands
800 children:
801 - title: npm
802 url: /cli/v8/commands/npm
803 description: JavaScript package manager
804 - title: npm access
805 url: /cli/v8/commands/npm-access
806 description: Set access level on published packages
807 - title: npm adduser
808 url: /cli/v8/commands/npm-adduser
809 description: Add a registry user account
810 - title: npm audit
811 url: /cli/v8/commands/npm-audit
812 description: Run a security audit
813 - title: npm bin
814 url: /cli/v8/commands/npm-bin
815 description: Display npm bin folder
816 - title: npm bugs
817 url: /cli/v8/commands/npm-bugs
818 description: Bugs for a package in a web browser maybe
819 - title: npm cache
820 url: /cli/v8/commands/npm-cache
821 description: Manipulates packages cache
822 - title: npm ci
823 url: /cli/v8/commands/npm-ci
824 description: Install a project with a clean slate
825 - title: npm completion
826 url: /cli/v8/commands/npm-completion
827 description: Tab completion for npm
828 - title: npm config
829 url: /cli/v8/commands/npm-config
830 description: Manage the npm configuration files
831 - title: npm dedupe
832 url: /cli/v8/commands/npm-dedupe
833 description: Reduce duplication
834 - title: npm deprecate
835 url: /cli/v8/commands/npm-deprecate
836 description: Deprecate a version of a package
837 - title: npm diff
838 url: /cli/v8/commands/npm-diff
839 description: The registry diff command
840 - title: npm dist-tag
841 url: /cli/v8/commands/npm-dist-tag
842 description: Modify package distribution tags
843 - title: npm docs
844 url: /cli/v8/commands/npm-docs
845 description: Docs for a package in a web browser maybe
846 - title: npm doctor
847 url: /cli/v8/commands/npm-doctor
848 description: Check your environments
849 - title: npm edit
850 url: /cli/v8/commands/npm-edit
851 description: Edit an installed package
852 - title: npm exec
853 url: /cli/v8/commands/npm-exec
854 description: Run a command from an npm package
855 - title: npm explain
856 url: /cli/v8/commands/npm-explain
857 description: Explain installed packages
858 - title: npm explore
859 url: /cli/v8/commands/npm-explore
860 description: Browse an installed package
861 - title: npm find-dupes
862 url: /cli/v8/commands/npm-find-dupes
863 description: Find duplication in the package tree
864 - title: npm fund
865 url: /cli/v8/commands/npm-fund
866 description: Retrieve funding information
867 - title: npm help
868 url: /cli/v8/commands/npm-help
869 description: Search npm help documentation
870 - title: npm help-search
871 url: /cli/v8/commands/npm-help-search
872 description: Get help on npm
873 - title: npm hook
874 url: /cli/v8/commands/npm-hook
875 description: Manage registry hooks
876 - title: npm init
877 url: /cli/v8/commands/npm-init
878 description: Create a package.json file
879 - title: npm install
880 url: /cli/v8/commands/npm-install
881 description: Install a package
882 - title: npm install-ci-test
883 url: /cli/v8/commands/npm-install-ci-test
884 description: Install a project with a clean slate and run tests
885 - title: npm install-test
886 url: /cli/v8/commands/npm-install-test
887 description: Install package(s) and run tests
888 - title: npm link
889 url: /cli/v8/commands/npm-link
890 description: Symlink a package folder
891 - title: npm logout
892 url: /cli/v8/commands/npm-logout
893 description: Log out of the registry
894 - title: npm ls
895 url: /cli/v8/commands/npm-ls
896 description: List installed packages
897 - title: npm org
898 url: /cli/v8/commands/npm-org
899 description: Manage orgs
900 - title: npm outdated
901 url: /cli/v8/commands/npm-outdated
902 description: Check for outdated packages
903 - title: npm owner
904 url: /cli/v8/commands/npm-owner
905 description: Manage package owners
906 - title: npm pack
907 url: /cli/v8/commands/npm-pack
908 description: Create a tarball from a package
909 - title: npm ping
910 url: /cli/v8/commands/npm-ping
911 description: Ping npm registry
912 - title: npm pkg
913 url: /cli/v8/commands/npm-pkg
914 description: Manages your package.json
915 - title: npm prefix
916 url: /cli/v8/commands/npm-prefix
917 description: Display prefix
918 - title: npm profile
919 url: /cli/v8/commands/npm-profile
920 description: Change settings on your registry profile
921 - title: npm prune
922 url: /cli/v8/commands/npm-prune
923 description: Remove extraneous packages
924 - title: npm publish
925 url: /cli/v8/commands/npm-publish
926 description: Publish a package
927 - title: npm query
928 url: /cli/v8/commands/npm-query
929 description: Retrieve a filtered list of packages
930 - title: npm rebuild
931 url: /cli/v8/commands/npm-rebuild
932 description: Rebuild a package
933 - title: npm repo
934 url: /cli/v8/commands/npm-repo
935 description: Open package repository page in the browser
936 - title: npm restart
937 url: /cli/v8/commands/npm-restart
938 description: Restart a package
939 - title: npm root
940 url: /cli/v8/commands/npm-root
941 description: Display npm root
942 - title: npm run-script
943 url: /cli/v8/commands/npm-run-script
944 description: Run arbitrary package scripts
945 - title: npm search
946 url: /cli/v8/commands/npm-search
947 description: Search for packages
948 - title: npm set-script
949 url: /cli/v8/commands/npm-set-script
950 description: Set tasks in the scripts section of package.json
951 - title: npm shrinkwrap
952 url: /cli/v8/commands/npm-shrinkwrap
953 description: Lock down dependency versions for publication
954 - title: npm star
955 url: /cli/v8/commands/npm-star
956 description: Mark your favorite packages
957 - title: npm stars
958 url: /cli/v8/commands/npm-stars
959 description: View packages marked as favorites
960 - title: npm start
961 url: /cli/v8/commands/npm-start
962 description: Start a package
963 - title: npm stop
964 url: /cli/v8/commands/npm-stop
965 description: Stop a package
966 - title: npm team
967 url: /cli/v8/commands/npm-team
968 description: Manage organization teams and team memberships
969 - title: npm test
970 url: /cli/v8/commands/npm-test
971 description: Test a package
972 - title: npm token
973 url: /cli/v8/commands/npm-token
974 description: Manage your authentication tokens
975 - title: npm uninstall
976 url: /cli/v8/commands/npm-uninstall
977 description: Remove a package
978 - title: npm unpublish
979 url: /cli/v8/commands/npm-unpublish
980 description: Remove a package from the registry
981 - title: npm unstar
982 url: /cli/v8/commands/npm-unstar
983 description: Remove an item from your favorite packages
984 - title: npm update
985 url: /cli/v8/commands/npm-update
986 description: Update a package
987 - title: npm version
988 url: /cli/v8/commands/npm-version
989 description: Bump a package version
990 - title: npm view
991 url: /cli/v8/commands/npm-view
992 description: View registry info
993 - title: npm whoami
994 url: /cli/v8/commands/npm-whoami
995 description: Display npm username
996 - title: npx
997 url: /cli/v8/commands/npx
998 description: Run a command from an npm package
999 - title: Configuring npm
1000 shortName: Configuring
1001 url: /cli/v8/configuring-npm
1002 children:
1003 - title: Install
1004 url: /cli/v8/configuring-npm/install
1005 description: Download and install node and npm
1006 - title: Folders
1007 url: /cli/v8/configuring-npm/folders
1008 description: Folder structures used by npm
1009 - title: .npmrc
1010 url: /cli/v8/configuring-npm/npmrc
1011 description: The npm config files
1012 - title: npm-shrinkwrap.json
1013 url: /cli/v8/configuring-npm/npm-shrinkwrap-json
1014 description: A publishable lockfile
1015 - title: package.json
1016 url: /cli/v8/configuring-npm/package-json
1017 description: Specifics of npm's package.json handling
1018 - title: package-lock.json
1019 url: /cli/v8/configuring-npm/package-lock-json
1020 description: A manifestation of the manifest
1021 - title: Using npm
1022 shortName: Using
1023 url: /cli/v8/using-npm
1024 children:
1025 - title: Registry
1026 url: /cli/v8/using-npm/registry
1027 description: The JavaScript Package Registry
1028 - title: Package spec
1029 url: /cli/v8/using-npm/package-spec
1030 description: Package name specifier
1031 - title: Config
1032 url: /cli/v8/using-npm/config
1033 description: About npm configuration
1034 - title: Logging
1035 url: /cli/v8/using-npm/logging
1036 description: Why, What & How we Log
1037 - title: Scope
1038 url: /cli/v8/using-npm/scope
1039 description: Scoped packages
1040 - title: Scripts
1041 url: /cli/v8/using-npm/scripts
1042 description: How npm handles the "scripts" field
1043 - title: Workspaces
1044 url: /cli/v8/using-npm/workspaces
1045 description: Working with workspaces
1046 - title: Organizations
1047 url: /cli/v8/using-npm/orgs
1048 description: Working with teams & organizations
1049 - title: Dependency Selectors
1050 url: /cli/v8/using-npm/dependency-selectors
1051 description: Dependency Selector Syntax & Querying
1052 - title: Developers
1053 url: /cli/v8/using-npm/developers
1054 description: Developer guide
1055 - title: Removal
1056 url: /cli/v8/using-npm/removal
1057 description: Cleaning the slate
1058 - title: Changelog
1059 url: /cli/v8/using-npm/changelog
1060 description: Changelog notes for each version
1061 - title: Version 9.9.4
1062 shortName: v9
1063 url: /cli/v9
1064 default: false
1065 type: legacy
1066 children:
1067 - title: CLI Commands
1068 shortName: Commands
1069 url: /cli/v9/commands
1070 children:
1071 - title: npm
1072 url: /cli/v9/commands/npm
1073 description: JavaScript package manager
1074 - title: npm access
1075 url: /cli/v9/commands/npm-access
1076 description: Set access level on published packages
1077 - title: npm adduser
1078 url: /cli/v9/commands/npm-adduser
1079 description: Add a registry user account
1080 - title: npm audit
1081 url: /cli/v9/commands/npm-audit
1082 description: Run a security audit
1083 - title: npm bugs
1084 url: /cli/v9/commands/npm-bugs
1085 description: Bugs for a package in a web browser maybe
1086 - title: npm cache
1087 url: /cli/v9/commands/npm-cache
1088 description: Manipulates packages cache
1089 - title: npm ci
1090 url: /cli/v9/commands/npm-ci
1091 description: Install a project with a clean slate
1092 - title: npm completion
1093 url: /cli/v9/commands/npm-completion
1094 description: Tab completion for npm
1095 - title: npm config
1096 url: /cli/v9/commands/npm-config
1097 description: Manage the npm configuration files
1098 - title: npm dedupe
1099 url: /cli/v9/commands/npm-dedupe
1100 description: Reduce duplication
1101 - title: npm deprecate
1102 url: /cli/v9/commands/npm-deprecate
1103 description: Deprecate a version of a package
1104 - title: npm diff
1105 url: /cli/v9/commands/npm-diff
1106 description: The registry diff command
1107 - title: npm dist-tag
1108 url: /cli/v9/commands/npm-dist-tag
1109 description: Modify package distribution tags
1110 - title: npm docs
1111 url: /cli/v9/commands/npm-docs
1112 description: Docs for a package in a web browser maybe
1113 - title: npm doctor
1114 url: /cli/v9/commands/npm-doctor
1115 description: Check your environments
1116 - title: npm edit
1117 url: /cli/v9/commands/npm-edit
1118 description: Edit an installed package
1119 - title: npm exec
1120 url: /cli/v9/commands/npm-exec
1121 description: Run a command from an npm package
1122 - title: npm explain
1123 url: /cli/v9/commands/npm-explain
1124 description: Explain installed packages
1125 - title: npm explore
1126 url: /cli/v9/commands/npm-explore
1127 description: Browse an installed package
1128 - title: npm find-dupes
1129 url: /cli/v9/commands/npm-find-dupes
1130 description: Find duplication in the package tree
1131 - title: npm fund
1132 url: /cli/v9/commands/npm-fund
1133 description: Retrieve funding information
1134 - title: npm help
1135 url: /cli/v9/commands/npm-help
1136 description: Search npm help documentation
1137 - title: npm help-search
1138 url: /cli/v9/commands/npm-help-search
1139 description: Get help on npm
1140 - title: npm hook
1141 url: /cli/v9/commands/npm-hook
1142 description: Manage registry hooks
1143 - title: npm init
1144 url: /cli/v9/commands/npm-init
1145 description: Create a package.json file
1146 - title: npm install
1147 url: /cli/v9/commands/npm-install
1148 description: Install a package
1149 - title: npm install-ci-test
1150 url: /cli/v9/commands/npm-install-ci-test
1151 description: Install a project with a clean slate and run tests
1152 - title: npm install-test
1153 url: /cli/v9/commands/npm-install-test
1154 description: Install package(s) and run tests
1155 - title: npm link
1156 url: /cli/v9/commands/npm-link
1157 description: Symlink a package folder
1158 - title: npm login
1159 url: /cli/v9/commands/npm-login
1160 description: Login to a registry user account
1161 - title: npm logout
1162 url: /cli/v9/commands/npm-logout
1163 description: Log out of the registry
1164 - title: npm ls
1165 url: /cli/v9/commands/npm-ls
1166 description: List installed packages
1167 - title: npm org
1168 url: /cli/v9/commands/npm-org
1169 description: Manage orgs
1170 - title: npm outdated
1171 url: /cli/v9/commands/npm-outdated
1172 description: Check for outdated packages
1173 - title: npm owner
1174 url: /cli/v9/commands/npm-owner
1175 description: Manage package owners
1176 - title: npm pack
1177 url: /cli/v9/commands/npm-pack
1178 description: Create a tarball from a package
1179 - title: npm ping
1180 url: /cli/v9/commands/npm-ping
1181 description: Ping npm registry
1182 - title: npm pkg
1183 url: /cli/v9/commands/npm-pkg
1184 description: Manages your package.json
1185 - title: npm prefix
1186 url: /cli/v9/commands/npm-prefix
1187 description: Display prefix
1188 - title: npm profile
1189 url: /cli/v9/commands/npm-profile
1190 description: Change settings on your registry profile
1191 - title: npm prune
1192 url: /cli/v9/commands/npm-prune
1193 description: Remove extraneous packages
1194 - title: npm publish
1195 url: /cli/v9/commands/npm-publish
1196 description: Publish a package
1197 - title: npm query
1198 url: /cli/v9/commands/npm-query
1199 description: Retrieve a filtered list of packages
1200 - title: npm rebuild
1201 url: /cli/v9/commands/npm-rebuild
1202 description: Rebuild a package
1203 - title: npm repo
1204 url: /cli/v9/commands/npm-repo
1205 description: Open package repository page in the browser
1206 - title: npm restart
1207 url: /cli/v9/commands/npm-restart
1208 description: Restart a package
1209 - title: npm root
1210 url: /cli/v9/commands/npm-root
1211 description: Display npm root
1212 - title: npm run-script
1213 url: /cli/v9/commands/npm-run-script
1214 description: Run arbitrary package scripts
1215 - title: npm sbom
1216 url: /cli/v9/commands/npm-sbom
1217 description: Generate a Software Bill of Materials (SBOM)
1218 - title: npm search
1219 url: /cli/v9/commands/npm-search
1220 description: Search for packages
1221 - title: npm shrinkwrap
1222 url: /cli/v9/commands/npm-shrinkwrap
1223 description: Lock down dependency versions for publication
1224 - title: npm star
1225 url: /cli/v9/commands/npm-star
1226 description: Mark your favorite packages
1227 - title: npm stars
1228 url: /cli/v9/commands/npm-stars
1229 description: View packages marked as favorites
1230 - title: npm start
1231 url: /cli/v9/commands/npm-start
1232 description: Start a package
1233 - title: npm stop
1234 url: /cli/v9/commands/npm-stop
1235 description: Stop a package
1236 - title: npm team
1237 url: /cli/v9/commands/npm-team
1238 description: Manage organization teams and team memberships
1239 - title: npm test
1240 url: /cli/v9/commands/npm-test
1241 description: Test a package
1242 - title: npm token
1243 url: /cli/v9/commands/npm-token
1244 description: Manage your authentication tokens
1245 - title: npm uninstall
1246 url: /cli/v9/commands/npm-uninstall
1247 description: Remove a package
1248 - title: npm unpublish
1249 url: /cli/v9/commands/npm-unpublish
1250 description: Remove a package from the registry
1251 - title: npm unstar
1252 url: /cli/v9/commands/npm-unstar
1253 description: Remove an item from your favorite packages
1254 - title: npm update
1255 url: /cli/v9/commands/npm-update
1256 description: Update a package
1257 - title: npm version
1258 url: /cli/v9/commands/npm-version
1259 description: Bump a package version
1260 - title: npm view
1261 url: /cli/v9/commands/npm-view
1262 description: View registry info
1263 - title: npm whoami
1264 url: /cli/v9/commands/npm-whoami
1265 description: Display npm username
1266 - title: npx
1267 url: /cli/v9/commands/npx
1268 description: Run a command from an npm package
1269 - title: Configuring npm
1270 shortName: Configuring
1271 url: /cli/v9/configuring-npm
1272 children:
1273 - title: Install
1274 url: /cli/v9/configuring-npm/install
1275 description: Download and install node and npm
1276 - title: Folders
1277 url: /cli/v9/configuring-npm/folders
1278 description: Folder structures used by npm
1279 - title: .npmrc
1280 url: /cli/v9/configuring-npm/npmrc
1281 description: The npm config files
1282 - title: npm-shrinkwrap.json
1283 url: /cli/v9/configuring-npm/npm-shrinkwrap-json
1284 description: A publishable lockfile
1285 - title: package.json
1286 url: /cli/v9/configuring-npm/package-json
1287 description: Specifics of npm's package.json handling
1288 - title: package-lock.json
1289 url: /cli/v9/configuring-npm/package-lock-json
1290 description: A manifestation of the manifest
1291 - title: Using npm
1292 shortName: Using
1293 url: /cli/v9/using-npm
1294 children:
1295 - title: Registry
1296 url: /cli/v9/using-npm/registry
1297 description: The JavaScript Package Registry
1298 - title: Package spec
1299 url: /cli/v9/using-npm/package-spec
1300 description: Package name specifier
1301 - title: Config
1302 url: /cli/v9/using-npm/config
1303 description: About npm configuration
1304 - title: Logging
1305 url: /cli/v9/using-npm/logging
1306 description: Why, What & How we Log
1307 - title: Scope
1308 url: /cli/v9/using-npm/scope
1309 description: Scoped packages
1310 - title: Scripts
1311 url: /cli/v9/using-npm/scripts
1312 description: How npm handles the "scripts" field
1313 - title: Workspaces
1314 url: /cli/v9/using-npm/workspaces
1315 description: Working with workspaces
1316 - title: Organizations
1317 url: /cli/v9/using-npm/orgs
1318 description: Working with teams & organizations
1319 - title: Dependency Selectors
1320 url: /cli/v9/using-npm/dependency-selectors
1321 description: Dependency Selector Syntax & Querying
1322 - title: Developers
1323 url: /cli/v9/using-npm/developers
1324 description: Developer guide
1325 - title: Removal
1326 url: /cli/v9/using-npm/removal
1327 description: Cleaning the slate
1328 - title: Changelog
1329 url: /cli/v9/using-npm/changelog
1330 description: Changelog notes for each version
1331 - title: Version 10.9.8
1332 shortName: v10
1333 url: /cli/v10
1334 default: false
1335 type: legacy
1336 children:
1337 - title: CLI Commands
1338 shortName: Commands
1339 url: /cli/v10/commands
1340 children:
1341 - title: npm
1342 url: /cli/v10/commands/npm
1343 description: JavaScript package manager
1344 - title: npm access
1345 url: /cli/v10/commands/npm-access
1346 description: Set access level on published packages
1347 - title: npm adduser
1348 url: /cli/v10/commands/npm-adduser
1349 description: Add a registry user account
1350 - title: npm audit
1351 url: /cli/v10/commands/npm-audit
1352 description: Run a security audit
1353 - title: npm bugs
1354 url: /cli/v10/commands/npm-bugs
1355 description: Bugs for a package in a web browser maybe
1356 - title: npm cache
1357 url: /cli/v10/commands/npm-cache
1358 description: Manipulates packages cache
1359 - title: npm ci
1360 url: /cli/v10/commands/npm-ci
1361 description: Install a project with a clean slate
1362 - title: npm completion
1363 url: /cli/v10/commands/npm-completion
1364 description: Tab completion for npm
1365 - title: npm config
1366 url: /cli/v10/commands/npm-config
1367 description: Manage the npm configuration files
1368 - title: npm dedupe
1369 url: /cli/v10/commands/npm-dedupe
1370 description: Reduce duplication
1371 - title: npm deprecate
1372 url: /cli/v10/commands/npm-deprecate
1373 description: Deprecate a version of a package
1374 - title: npm diff
1375 url: /cli/v10/commands/npm-diff
1376 description: The registry diff command
1377 - title: npm dist-tag
1378 url: /cli/v10/commands/npm-dist-tag
1379 description: Modify package distribution tags
1380 - title: npm docs
1381 url: /cli/v10/commands/npm-docs
1382 description: Docs for a package in a web browser maybe
1383 - title: npm doctor
1384 url: /cli/v10/commands/npm-doctor
1385 description: Check your environments
1386 - title: npm edit
1387 url: /cli/v10/commands/npm-edit
1388 description: Edit an installed package
1389 - title: npm exec
1390 url: /cli/v10/commands/npm-exec
1391 description: Run a command from an npm package
1392 - title: npm explain
1393 url: /cli/v10/commands/npm-explain
1394 description: Explain installed packages
1395 - title: npm explore
1396 url: /cli/v10/commands/npm-explore
1397 description: Browse an installed package
1398 - title: npm find-dupes
1399 url: /cli/v10/commands/npm-find-dupes
1400 description: Find duplication in the package tree
1401 - title: npm fund
1402 url: /cli/v10/commands/npm-fund
1403 description: Retrieve funding information
1404 - title: npm help
1405 url: /cli/v10/commands/npm-help
1406 description: Search npm help documentation
1407 - title: npm help-search
1408 url: /cli/v10/commands/npm-help-search
1409 description: Get help on npm
1410 - title: npm hook
1411 url: /cli/v10/commands/npm-hook
1412 description: Manage registry hooks
1413 - title: npm init
1414 url: /cli/v10/commands/npm-init
1415 description: Create a package.json file
1416 - title: npm install
1417 url: /cli/v10/commands/npm-install
1418 description: Install a package
1419 - title: npm install-ci-test
1420 url: /cli/v10/commands/npm-install-ci-test
1421 description: Install a project with a clean slate and run tests
1422 - title: npm install-test
1423 url: /cli/v10/commands/npm-install-test
1424 description: Install package(s) and run tests
1425 - title: npm link
1426 url: /cli/v10/commands/npm-link
1427 description: Symlink a package folder
1428 - title: npm login
1429 url: /cli/v10/commands/npm-login
1430 description: Login to a registry user account
1431 - title: npm logout
1432 url: /cli/v10/commands/npm-logout
1433 description: Log out of the registry
1434 - title: npm ls
1435 url: /cli/v10/commands/npm-ls
1436 description: List installed packages
1437 - title: npm org
1438 url: /cli/v10/commands/npm-org
1439 description: Manage orgs
1440 - title: npm outdated
1441 url: /cli/v10/commands/npm-outdated
1442 description: Check for outdated packages
1443 - title: npm owner
1444 url: /cli/v10/commands/npm-owner
1445 description: Manage package owners
1446 - title: npm pack
1447 url: /cli/v10/commands/npm-pack
1448 description: Create a tarball from a package
1449 - title: npm ping
1450 url: /cli/v10/commands/npm-ping
1451 description: Ping npm registry
1452 - title: npm pkg
1453 url: /cli/v10/commands/npm-pkg
1454 description: Manages your package.json
1455 - title: npm prefix
1456 url: /cli/v10/commands/npm-prefix
1457 description: Display prefix
1458 - title: npm profile
1459 url: /cli/v10/commands/npm-profile
1460 description: Change settings on your registry profile
1461 - title: npm prune
1462 url: /cli/v10/commands/npm-prune
1463 description: Remove extraneous packages
1464 - title: npm publish
1465 url: /cli/v10/commands/npm-publish
1466 description: Publish a package
1467 - title: npm query
1468 url: /cli/v10/commands/npm-query
1469 description: Retrieve a filtered list of packages
1470 - title: npm rebuild
1471 url: /cli/v10/commands/npm-rebuild
1472 description: Rebuild a package
1473 - title: npm repo
1474 url: /cli/v10/commands/npm-repo
1475 description: Open package repository page in the browser
1476 - title: npm restart
1477 url: /cli/v10/commands/npm-restart
1478 description: Restart a package
1479 - title: npm root
1480 url: /cli/v10/commands/npm-root
1481 description: Display npm root
1482 - title: npm run-script
1483 url: /cli/v10/commands/npm-run-script
1484 description: Run arbitrary package scripts
1485 - title: npm sbom
1486 url: /cli/v10/commands/npm-sbom
1487 description: Generate a Software Bill of Materials (SBOM)
1488 - title: npm search
1489 url: /cli/v10/commands/npm-search
1490 description: Search for packages
1491 - title: npm shrinkwrap
1492 url: /cli/v10/commands/npm-shrinkwrap
1493 description: Lock down dependency versions for publication
1494 - title: npm star
1495 url: /cli/v10/commands/npm-star
1496 description: Mark your favorite packages
1497 - title: npm stars
1498 url: /cli/v10/commands/npm-stars
1499 description: View packages marked as favorites
1500 - title: npm start
1501 url: /cli/v10/commands/npm-start
1502 description: Start a package
1503 - title: npm stop
1504 url: /cli/v10/commands/npm-stop
1505 description: Stop a package
1506 - title: npm team
1507 url: /cli/v10/commands/npm-team
1508 description: Manage organization teams and team memberships
1509 - title: npm test
1510 url: /cli/v10/commands/npm-test
1511 description: Test a package
1512 - title: npm token
1513 url: /cli/v10/commands/npm-token
1514 description: Manage your authentication tokens
1515 - title: npm uninstall
1516 url: /cli/v10/commands/npm-uninstall
1517 description: Remove a package
1518 - title: npm unpublish
1519 url: /cli/v10/commands/npm-unpublish
1520 description: Remove a package from the registry
1521 - title: npm unstar
1522 url: /cli/v10/commands/npm-unstar
1523 description: Remove an item from your favorite packages
1524 - title: npm update
1525 url: /cli/v10/commands/npm-update
1526 description: Update a package
1527 - title: npm version
1528 url: /cli/v10/commands/npm-version
1529 description: Bump a package version
1530 - title: npm view
1531 url: /cli/v10/commands/npm-view
1532 description: View registry info
1533 - title: npm whoami
1534 url: /cli/v10/commands/npm-whoami
1535 description: Display npm username
1536 - title: npx
1537 url: /cli/v10/commands/npx
1538 description: Run a command from an npm package
1539 - title: Configuring npm
1540 shortName: Configuring
1541 url: /cli/v10/configuring-npm
1542 children:
1543 - title: Install
1544 url: /cli/v10/configuring-npm/install
1545 description: Download and install node and npm
1546 - title: Folders
1547 url: /cli/v10/configuring-npm/folders
1548 description: Folder structures used by npm
1549 - title: .npmrc
1550 url: /cli/v10/configuring-npm/npmrc
1551 description: The npm config files
1552 - title: npm-shrinkwrap.json
1553 url: /cli/v10/configuring-npm/npm-shrinkwrap-json
1554 description: A publishable lockfile
1555 - title: package.json
1556 url: /cli/v10/configuring-npm/package-json
1557 description: Specifics of npm's package.json handling
1558 - title: package-lock.json
1559 url: /cli/v10/configuring-npm/package-lock-json
1560 description: A manifestation of the manifest
1561 - title: Using npm
1562 shortName: Using
1563 url: /cli/v10/using-npm
1564 children:
1565 - title: Registry
1566 url: /cli/v10/using-npm/registry
1567 description: The JavaScript Package Registry
1568 - title: Package spec
1569 url: /cli/v10/using-npm/package-spec
1570 description: Package name specifier
1571 - title: Config
1572 url: /cli/v10/using-npm/config
1573 description: About npm configuration
1574 - title: Logging
1575 url: /cli/v10/using-npm/logging
1576 description: Why, What & How we Log
1577 - title: Scope
1578 url: /cli/v10/using-npm/scope
1579 description: Scoped packages
1580 - title: Scripts
1581 url: /cli/v10/using-npm/scripts
1582 description: How npm handles the "scripts" field
1583 - title: Workspaces
1584 url: /cli/v10/using-npm/workspaces
1585 description: Working with workspaces
1586 - title: Organizations
1587 url: /cli/v10/using-npm/orgs
1588 description: Working with teams & organizations
1589 - title: Dependency Selectors
1590 url: /cli/v10/using-npm/dependency-selectors
1591 description: Dependency Selector Syntax & Querying
1592 - title: Developers
1593 url: /cli/v10/using-npm/developers
1594 description: Developer guide
1595 - title: Removal
1596 url: /cli/v10/using-npm/removal
1597 description: Cleaning the slate
1598 - title: Changelog
1599 url: /cli/v10/using-npm/changelog
1600 description: Changelog notes for each version
1601 - title: Version 11.16.0
1602 shortName: v11
1603 url: /cli/v11
1604 default: true
1605 type: latest
1606 children:
1607 - title: CLI Commands
1608 shortName: Commands
1609 url: /cli/v11/commands
1610 children:
1611 - title: npm
1612 url: /cli/v11/commands/npm
1613 description: javascript package manager
1614 - title: npm access
1615 url: /cli/v11/commands/npm-access
1616 description: Set access level on published packages
1617 - title: npm approve-scripts
1618 url: /cli/v11/commands/npm-approve-scripts
1619 description: Approve install scripts for specific dependencies
1620 - title: npm audit
1621 url: /cli/v11/commands/npm-audit
1622 description: Run a security audit
1623 - title: npm bugs
1624 url: /cli/v11/commands/npm-bugs
1625 description: Report bugs for a package in a web browser
1626 - title: npm cache
1627 url: /cli/v11/commands/npm-cache
1628 description: Manipulates packages cache
1629 - title: npm ci
1630 url: /cli/v11/commands/npm-ci
1631 description: Clean install a project
1632 - title: npm completion
1633 url: /cli/v11/commands/npm-completion
1634 description: Tab Completion for npm
1635 - title: npm config
1636 url: /cli/v11/commands/npm-config
1637 description: Manage the npm configuration files
1638 - title: npm dedupe
1639 url: /cli/v11/commands/npm-dedupe
1640 description: Reduce duplication in the package tree
1641 - title: npm deny-scripts
1642 url: /cli/v11/commands/npm-deny-scripts
1643 description: Deny install scripts for specific dependencies
1644 - title: npm deprecate
1645 url: /cli/v11/commands/npm-deprecate
1646 description: Deprecate a version of a package
1647 - title: npm diff
1648 url: /cli/v11/commands/npm-diff
1649 description: The registry diff command
1650 - title: npm dist-tag
1651 url: /cli/v11/commands/npm-dist-tag
1652 description: Modify package distribution tags
1653 - title: npm docs
1654 url: /cli/v11/commands/npm-docs
1655 description: Open documentation for a package in a web browser
1656 - title: npm doctor
1657 url: /cli/v11/commands/npm-doctor
1658 description: Check the health of your npm environment
1659 - title: npm edit
1660 url: /cli/v11/commands/npm-edit
1661 description: Edit an installed package
1662 - title: npm exec
1663 url: /cli/v11/commands/npm-exec
1664 description: Run a command from a local or remote npm package
1665 - title: npm explain
1666 url: /cli/v11/commands/npm-explain
1667 description: Explain installed packages
1668 - title: npm explore
1669 url: /cli/v11/commands/npm-explore
1670 description: Browse an installed package
1671 - title: npm find-dupes
1672 url: /cli/v11/commands/npm-find-dupes
1673 description: Find duplication in the package tree
1674 - title: npm fund
1675 url: /cli/v11/commands/npm-fund
1676 description: Retrieve funding information
1677 - title: npm get
1678 url: /cli/v11/commands/npm-get
1679 description: Get a value from the npm configuration
1680 - title: npm help
1681 url: /cli/v11/commands/npm-help
1682 description: Get help on npm
1683 - title: npm help-search
1684 url: /cli/v11/commands/npm-help-search
1685 description: Search npm help documentation
1686 - title: npm init
1687 url: /cli/v11/commands/npm-init
1688 description: Create a package.json file
1689 - title: npm install
1690 url: /cli/v11/commands/npm-install
1691 description: Install a package
1692 - title: npm install-ci-test
1693 url: /cli/v11/commands/npm-install-ci-test
1694 description: Install a project with a clean slate and run tests
1695 - title: npm install-test
1696 url: /cli/v11/commands/npm-install-test
1697 description: Install package(s) and run tests
1698 - title: npm link
1699 url: /cli/v11/commands/npm-link
1700 description: Symlink a package folder
1701 - title: npm ll
1702 url: /cli/v11/commands/npm-ll
1703 description: List installed packages
1704 - title: npm login
1705 url: /cli/v11/commands/npm-login
1706 description: Login to a registry user account
1707 - title: npm logout
1708 url: /cli/v11/commands/npm-logout
1709 description: Log out of the registry
1710 - title: npm ls
1711 url: /cli/v11/commands/npm-ls
1712 description: List installed packages
1713 - title: npm org
1714 url: /cli/v11/commands/npm-org
1715 description: Manage orgs
1716 - title: npm outdated
1717 url: /cli/v11/commands/npm-outdated
1718 description: Check for outdated packages
1719 - title: npm owner
1720 url: /cli/v11/commands/npm-owner
1721 description: Manage package owners
1722 - title: npm pack
1723 url: /cli/v11/commands/npm-pack
1724 description: Create a tarball from a package
1725 - title: npm ping
1726 url: /cli/v11/commands/npm-ping
1727 description: Ping npm registry
1728 - title: npm pkg
1729 url: /cli/v11/commands/npm-pkg
1730 description: Manages your package.json
1731 - title: npm prefix
1732 url: /cli/v11/commands/npm-prefix
1733 description: Display prefix
1734 - title: npm profile
1735 url: /cli/v11/commands/npm-profile
1736 description: Change settings on your registry profile
1737 - title: npm prune
1738 url: /cli/v11/commands/npm-prune
1739 description: Remove extraneous packages
1740 - title: npm publish
1741 url: /cli/v11/commands/npm-publish
1742 description: Publish a package
1743 - title: npm query
1744 url: /cli/v11/commands/npm-query
1745 description: Dependency selector query
1746 - title: npm rebuild
1747 url: /cli/v11/commands/npm-rebuild
1748 description: Rebuild a package
1749 - title: npm repo
1750 url: /cli/v11/commands/npm-repo
1751 description: Open package repository page in the browser
1752 - title: npm restart
1753 url: /cli/v11/commands/npm-restart
1754 description: Restart a package
1755 - title: npm root
1756 url: /cli/v11/commands/npm-root
1757 description: Display npm root
1758 - title: npm run
1759 url: /cli/v11/commands/npm-run
1760 description: Run arbitrary package scripts
1761 - title: npm sbom
1762 url: /cli/v11/commands/npm-sbom
1763 description: Generate a Software Bill of Materials (SBOM)
1764 - title: npm search
1765 url: /cli/v11/commands/npm-search
1766 description: Search for packages
1767 - title: npm set
1768 url: /cli/v11/commands/npm-set
1769 description: Set a value in the npm configuration
1770 - title: npm stage
1771 url: /cli/v11/commands/npm-stage
1772 description: Stage packages for publishing
1773 - title: npm start
1774 url: /cli/v11/commands/npm-start
1775 description: Start a package
1776 - title: npm stop
1777 url: /cli/v11/commands/npm-stop
1778 description: Stop a package
1779 - title: npm team
1780 url: /cli/v11/commands/npm-team
1781 description: Manage organization teams and team memberships
1782 - title: npm test
1783 url: /cli/v11/commands/npm-test
1784 description: Test a package
1785 - title: npm token
1786 url: /cli/v11/commands/npm-token
1787 description: Manage your authentication tokens
1788 - title: npm trust
1789 url: /cli/v11/commands/npm-trust
1790 description: Manage trusted publishing relationships between packages and CI/CD providers
1791 - title: npm undeprecate
1792 url: /cli/v11/commands/npm-undeprecate
1793 description: Undeprecate a version of a package
1794 - title: npm uninstall
1795 url: /cli/v11/commands/npm-uninstall
1796 description: Remove a package
1797 - title: npm unpublish
1798 url: /cli/v11/commands/npm-unpublish
1799 description: Remove a package from the registry
1800 - title: npm update
1801 url: /cli/v11/commands/npm-update
1802 description: Update packages
1803 - title: npm version
1804 url: /cli/v11/commands/npm-version
1805 description: Bump a package version
1806 - title: npm view
1807 url: /cli/v11/commands/npm-view
1808 description: View registry info
1809 - title: npm whoami
1810 url: /cli/v11/commands/npm-whoami
1811 description: Display npm username
1812 - title: npx
1813 url: /cli/v11/commands/npx
1814 description: Run a command from a local or remote npm package
1815 - title: Configuring npm
1816 shortName: Configuring
1817 url: /cli/v11/configuring-npm
1818 children:
1819 - title: Install
1820 url: /cli/v11/configuring-npm/install
1821 description: Download and install node and npm
1822 - title: Folders
1823 url: /cli/v11/configuring-npm/folders
1824 description: Folder structures used by npm
1825 - title: .npmrc
1826 url: /cli/v11/configuring-npm/npmrc
1827 description: The npm config files
1828 - title: package.json
1829 url: /cli/v11/configuring-npm/package-json
1830 description: Specifics of npm's package.json handling
1831 - title: package-lock.json
1832 url: /cli/v11/configuring-npm/package-lock-json
1833 description: A manifestation of the manifest
1834 - title: Using npm
1835 shortName: Using
1836 url: /cli/v11/using-npm
1837 children:
1838 - title: Registry
1839 url: /cli/v11/using-npm/registry
1840 description: The JavaScript Package Registry
1841 - title: Package spec
1842 url: /cli/v11/using-npm/package-spec
1843 description: Package name specifier
1844 - title: Config
1845 url: /cli/v11/using-npm/config
1846 description: About npm configuration
1847 - title: Logging
1848 url: /cli/v11/using-npm/logging
1849 description: Why, What & How we Log
1850 - title: Scope
1851 url: /cli/v11/using-npm/scope
1852 description: Scoped packages
1853 - title: Scripts
1854 url: /cli/v11/using-npm/scripts
1855 description: How npm handles the "scripts" field
1856 - title: Workspaces
1857 url: /cli/v11/using-npm/workspaces
1858 description: Working with workspaces
1859 - title: Organizations
1860 url: /cli/v11/using-npm/orgs
1861 description: Working with teams & organizations
1862 - title: Dependency Selectors
1863 url: /cli/v11/using-npm/dependency-selectors
1864 description: Dependency Selector Syntax & Querying
1865 - title: Developers
1866 url: /cli/v11/using-npm/developers
1867 description: Developer guide
1868 - title: Removal
1869 url: /cli/v11/using-npm/removal
1870 description: Cleaning the slate
1871 - title: Changelog
1872 url: /cli/v11/using-npm/changelog
1873 description: Changelog notes for each version