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