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