forked from npm/documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathnav.yml
More file actions
1321 lines (1320 loc) · 56.9 KB
/
nav.yml
File metadata and controls
1321 lines (1320 loc) · 56.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# For registry content, edit this file.
# The CLI content in this file is automatically generated. Do not edit.
# For CLI content, edit `docs/nav.yml` in https://github.com/npm/cli.
- title: About npm
url: /about-npm
- title: Getting started
url: /getting-started
children:
- title: Setting up your npm user account
shortName: Setting up your account
url: /getting-started/setting-up-your-npm-user-account
children:
- title: Creating a new user account on the public registry
url: /creating-a-new-npm-user-account
- title: Creating a strong password
url: /creating-a-strong-password
- title: Receiving a one-time password over email
url: /receiving-a-one-time-password-over-email
- title: About two-factor authentication
url: /about-two-factor-authentication
- title: Configuring two-factor authentication
url: /configuring-two-factor-authentication
- title: Accessing npm using two-factor authentication
url: /accessing-npm-using-2fa
- title: Recovering your 2FA-enabled account
url: /recovering-your-2fa-enabled-account
- title: Managing your npm user account
shortName: Managing your account
url: /getting-started/managing-your-npm-user-account
children:
- title: Managing your profile settings
url: /managing-your-profile-settings
- title: Changing your npm username
url: /changing-your-npm-username
- title: Deleting your npm user account
url: /deleting-your-npm-user-account
- title: Requesting an export of your personal data
url: /requesting-your-data
- title: Paying for your npm user account
shortName: Paying for your account
url: /getting-started/paying-for-your-npm-user-account
children:
- title: Upgrading to a paid user account plan
url: /upgrading-to-a-paid-user-account-plan
- title: Viewing, downloading, and emailing receipts for your npm user account
url: /viewing-downloading-and-emailing-receipts-for-your-user-account
- title: Updating user account billing settings
url: /updating-user-account-billing-settings
- title: Downgrading to a free user account plan
url: /downgrading-to-a-free-user-account-plan
- title: Configuring your local environment
shortName: Configuring
url: /getting-started/configuring-your-local-environment
children:
- title: About npm CLI versions
url: /about-npm-versions
- title: Downloading and installing Node.js and npm
url: /downloading-and-installing-node-js-and-npm
- title: Troubleshooting
url: /getting-started/troubleshooting
children:
- title: Generating and locating npm-debug.log files
url: /generating-and-locating-npm-debug.log-files
- title: Common errors
url: /common-errors
- title: Try the latest stable version of node
url: /try-the-latest-stable-version-of-node
- title: Try the latest stable version of npm
url: /try-the-latest-stable-version-of-npm
- title: Packages and modules
url: /packages-and-modules
children:
- title: Introduction to packages and modules
shortName: Introduction
url: /packages-and-modules/introduction-to-packages-and-modules
children:
- title: About the public npm registry
url: /about-the-public-npm-registry
- title: About packages and modules
url: /about-packages-and-modules
- title: About scopes
url: /about-scopes
- title: About public packages
url: /about-public-packages
- title: About private packages
url: /about-private-packages
- title: npm package scope, access level, and visibility
url: /package-scope-access-level-and-visibility
- title: Contributing packages to the registry
shortName: Contributing
url: /packages-and-modules/contributing-packages-to-the-registry
children:
- title: Creating a package.json file
url: /creating-a-package-json-file
- title: Creating Node.js modules
url: /creating-node-js-modules
- title: About package README files
url: /about-package-readme-files
- title: Creating and publishing unscoped public packages
url: /creating-and-publishing-unscoped-public-packages
- title: Creating and publishing scoped public packages
url: /creating-and-publishing-scoped-public-packages
- title: Creating and publishing private packages
url: /creating-and-publishing-private-packages
- title: Package name guidelines
url: /package-name-guidelines
- title: Specifying dependencies and devDependencies in a package.json file
url: /specifying-dependencies-and-devdependencies-in-a-package-json-file
- title: About semantic versioning
url: /about-semantic-versioning
- title: Adding dist-tags to packages
url: /adding-dist-tags-to-packages
- title: Updating and managing your published packages
shortName: Updating and managing
url: /packages-and-modules/updating-and-managing-your-published-packages
children:
- title: Changing package visibility
url: /changing-package-visibility
- title: Adding collaborators to private packages owned by a user account
url: /adding-collaborators-to-private-packages-owned-by-a-user-account
- title: Updating your published package version number
url: /updating-your-published-package-version-number
- title: Deprecating and undeprecating packages or package versions
url: /deprecating-and-undeprecating-packages-or-package-versions
- title: Transferring a package from a user account to another user account
url: /transferring-a-package-from-a-user-account-to-another-user-account
- title: Unpublishing packages from the registry
url: /unpublishing-packages-from-the-registry
- title: Getting packages from the registry
shortName: Getting packages
url: /packages-and-modules/getting-packages-from-the-registry
children:
- title: Searching for and choosing packages to download
url: /searching-for-and-choosing-packages-to-download
- title: Downloading and installing packages locally
url: /downloading-and-installing-packages-locally
- title: Downloading and installing packages globally
url: /downloading-and-installing-packages-globally
- title: Resolving EACCES permissions errors when installing packages globally
url: /resolving-eacces-permissions-errors-when-installing-packages-globally
- title: Updating packages downloaded from the registry
url: /updating-packages-downloaded-from-the-registry
- title: Using npm packages in your projects
url: /using-npm-packages-in-your-projects
- title: Using deprecated packages
url: /using-deprecated-packages
- title: Uninstalling packages and dependencies
url: /uninstalling-packages-and-dependencies
- title: Securing your code
url: /packages-and-modules/securing-your-code
children:
- title: About audit reports
url: /about-audit-reports
- title: Auditing package dependencies for security vulnerabilities
url: /auditing-package-dependencies-for-security-vulnerabilities
- title: About ECDSA registry signatures
url: /about-registry-signatures
- title: Verifying ECDSA registry signatures
url: /verifying-registry-signatures
- title: About PGP registry signatures (deprecated)
url: /about-pgp-signatures-for-packages-in-the-public-registry
- title: Verifying PGP registry signatures (deprecated)
url: /verifying-the-pgp-signature-for-a-package-from-the-npm-public-registry
- title: Requiring 2FA for package publishing and settings modification
url: /requiring-2fa-for-package-publishing-and-settings-modification
- title: Reporting malware in an npm package
url: /reporting-malware-in-an-npm-package
- title: Integrations
url: /integrations
children:
- title: Integrating npm with external services
shortName: Integrating with external services
url: /integrations/integrating-npm-with-external-services
children:
- title: About access tokens
url: /about-access-tokens
- title: Creating and viewing access tokens
url: /creating-and-viewing-access-tokens
- title: Revoking access tokens
url: /revoking-access-tokens
- title: Using private packages in a CI/CD workflow
url: /using-private-packages-in-a-ci-cd-workflow
- title: Docker and private modules
url: /docker-and-private-modules
- title: Organizations
url: /organizations
children:
- title: Creating and managing organizations
shortName: Creating
url: /organizations/creating-and-managing-organizations
children:
- title: Creating an organization
url: /creating-an-organization
- title: Converting your user account to an organization
url: /converting-your-user-account-to-an-organization
- title: Requiring two-factor authentication in your organization
url: /requiring-two-factor-authentication-in-your-organization
- title: Renaming an organization
url: /renaming-an-organization
- title: Deleting an organization
url: /deleting-an-organization
- title: Paying for your organization
shortName: Paying
url: /organizations/paying-for-your-organization
children:
- title: Upgrading to a paid organization plan
url: /upgrading-to-a-paid-organization-plan
- title: Viewing, downloading, and emailing receipts for your organization
url: /viewing-downloading-and-emailing-receipts-for-your-organization
- title: Updating organization billing settings
url: /updating-organization-billing-settings
- title: Downgrading to a free organization plan
url: /downgrading-to-a-free-organization-plan
- title: Managing organization members
shortName: Managing members
url: /organizations/managing-organization-members
children:
- title: Adding members to your organization
url: /adding-members-to-your-organization
- title: Accepting or rejecting an organization invitation
url: /accepting-or-rejecting-an-organization-invitation
- title: Organization roles and permissions
url: /organization-roles-and-permissions
- title: Managing organization permissions
url: /managing-organization-permissions
- title: Removing members from your organization
url: /removing-members-from-your-organization
- title: Managing teams
url: /organizations/managing-teams
children:
- title: About the developers team
url: /about-developers-team
- title: Creating teams
url: /creating-teams
- title: Adding organization members to teams
url: /adding-organization-members-to-teams
- title: Removing organization members from teams
url: /removing-organization-members-from-teams
- title: Managing team access to organization packages
url: /managing-team-access-to-organization-packages
- title: Removing teams
url: /removing-teams
- title: Managing organization packages
shortName: Managing packages
url: /organizations/managing-organization-packages
children:
- title: About organization scopes and packages
url: /about-organization-scopes-and-packages
- title: Configuring your npm client with your organization settings
url: /configuring-your-npm-client-with-your-organization-settings
- title: Creating and publishing an organization scoped package
url: /creating-and-publishing-an-organization-scoped-package
- title: Policies
url: /policies
children:
- title: Terms of Use
url: /policies/terms
- title: Open Source Terms
url: /policies/open-source-terms
- title: Private Terms
url: /policies/private-terms
- title: Code of Conduct
url: /policies/conduct
- title: Package Name Disputes
url: /policies/disputes
- title: npm License
url: /policies/npm-license
- title: Privacy Policy
url: /policies/privacy
- title: Unpublish Policy
url: /policies/unpublish
- title: Copyright and DMCA Policy
url: /policies/dmca
- title: Logos and Usage
url: /policies/logos-and-usage
- title: Security
url: /policies/security
- title: Replication and web crawler policy
url: /policies/crawlers
- title: Threats and Mitigations
shortName: threats and mitigations
url: /threats-and-mitigations
- title: npm CLI
shortName: CLI
url: /cli
variants:
- title: Version 6.14.18 (Legacy Release)
shortName: v6
url: /cli/v6
default: false
children:
- title: CLI Commands
shortName: Commands
url: /cli/v6/commands
children:
- title: npm
url: /cli/v6/commands/npm
description: JavaScript package manager
- title: npm access
url: /cli/v6/commands/npm-access
description: Set access level on published packages
- title: npm adduser
url: /cli/v6/commands/npm-adduser
description: Add a registry user account
- title: npm audit
url: /cli/v6/commands/npm-audit
description: Run a security audit
- title: npm bin
url: /cli/v6/commands/npm-bin
description: Display npm bin folder
- title: npm bugs
url: /cli/v6/commands/npm-bugs
description: Bugs for a package in a web browser maybe
- title: npm build
url: /cli/v6/commands/npm-build
description: Build a package
- title: npm bundle
url: /cli/v6/commands/npm-bundle
description: Removed
- title: npm cache
url: /cli/v6/commands/npm-cache
description: Manipulates packages cache
- title: npm ci
url: /cli/v6/commands/npm-ci
description: Install a project with a clean slate
- title: npm completion
url: /cli/v6/commands/npm-completion
description: Tab completion for npm
- title: npm config
url: /cli/v6/commands/npm-config
description: Manage the npm configuration files
- title: npm dedupe
url: /cli/v6/commands/npm-dedupe
description: Reduce duplication
- title: npm deprecate
url: /cli/v6/commands/npm-deprecate
description: Deprecate a version of a package
- title: npm dist-tag
url: /cli/v6/commands/npm-dist-tag
description: Modify package distribution tags
- title: npm docs
url: /cli/v6/commands/npm-docs
description: Docs for a package in a web browser maybe
- title: npm doctor
url: /cli/v6/commands/npm-doctor
description: Check your environments
- title: npm edit
url: /cli/v6/commands/npm-edit
description: Edit an installed package
- title: npm explore
url: /cli/v6/commands/npm-explore
description: Browse an installed package
- title: npm fund
url: /cli/v6/commands/npm-fund
description: Retrieve funding information
- title: npm help
url: /cli/v6/commands/npm-help
description: Search npm help documentation
- title: npm help-search
url: /cli/v6/commands/npm-help-search
description: Get help on npm
- title: npm hook
url: /cli/v6/commands/npm-hook
description: Manage registry hooks
- title: npm init
url: /cli/v6/commands/npm-init
description: Create a package.json file
- title: npm install
url: /cli/v6/commands/npm-install
description: Install a package
- title: npm install-ci-test
url: /cli/v6/commands/npm-install-ci-test
description: Install a project with a clean slate and run tests
- title: npm install-test
url: /cli/v6/commands/npm-install-test
description: Install package(s) and run tests
- title: npm link
url: /cli/v6/commands/npm-link
description: Symlink a package folder
- title: npm logout
url: /cli/v6/commands/npm-logout
description: Log out of the registry
- title: npm ls
url: /cli/v6/commands/npm-ls
description: List installed packages
- title: npm org
url: /cli/v6/commands/npm-org
description: Manage orgs
- title: npm outdated
url: /cli/v6/commands/npm-outdated
description: Check for outdated packages
- title: npm owner
url: /cli/v6/commands/npm-owner
description: Manage package owners
- title: npm pack
url: /cli/v6/commands/npm-pack
description: Create a tarball from a package
- title: npm ping
url: /cli/v6/commands/npm-ping
description: Ping npm registry
- title: npm prefix
url: /cli/v6/commands/npm-prefix
description: Display prefix
- title: npm profile
url: /cli/v6/commands/npm-profile
description: Change settings on your registry profile
- title: npm prune
url: /cli/v6/commands/npm-prune
description: Remove extraneous packages
- title: npm publish
url: /cli/v6/commands/npm-publish
description: Publish a package
- title: npm rebuild
url: /cli/v6/commands/npm-rebuild
description: Rebuild a package
- title: npm repo
url: /cli/v6/commands/npm-repo
description: Open package repository page in the browser
- title: npm restart
url: /cli/v6/commands/npm-restart
description: Restart a package
- title: npm root
url: /cli/v6/commands/npm-root
description: Display npm root
- title: npm run-script
url: /cli/v6/commands/npm-run-script
description: Run arbitrary package scripts
- title: npm search
url: /cli/v6/commands/npm-search
description: Search for packages
- title: npm shrinkwrap
url: /cli/v6/commands/npm-shrinkwrap
description: Lock down dependency versions for publication
- title: npm star
url: /cli/v6/commands/npm-star
description: Mark your favorite packages
- title: npm stars
url: /cli/v6/commands/npm-stars
description: View packages marked as favorites
- title: npm start
url: /cli/v6/commands/npm-start
description: Start a package
- title: npm stop
url: /cli/v6/commands/npm-stop
description: Stop a package
- title: npm team
url: /cli/v6/commands/npm-team
description: Manage organization teams and team memberships
- title: npm test
url: /cli/v6/commands/npm-test
description: Test a package
- title: npm token
url: /cli/v6/commands/npm-token
description: Manage your authentication tokens
- title: npm uninstall
url: /cli/v6/commands/npm-uninstall
description: Remove a package
- title: npm unpublish
url: /cli/v6/commands/npm-unpublish
description: Remove a package from the registry
- title: npm update
url: /cli/v6/commands/npm-update
description: Update a package
- title: npm version
url: /cli/v6/commands/npm-version
description: Bump a package version
- title: npm view
url: /cli/v6/commands/npm-view
description: View registry info
- title: npm whoami
url: /cli/v6/commands/npm-whoami
description: Display npm username
- title: Configuring npm
shortName: Configuring
url: /cli/v6/configuring-npm
children:
- title: Install
url: /cli/v6/configuring-npm/install
description: Download and install node and npm
- title: Folders
url: /cli/v6/configuring-npm/folders
description: Folder structures used by npm
- title: .npmrc
url: /cli/v6/configuring-npm/npmrc
description: The npm config files
- title: package.json
url: /cli/v6/configuring-npm/package-json
description: Specifics of npm's package.json handling
- title: package-locks
url: /cli/v6/configuring-npm/package-locks
description: An explanation of npm lockfiles
- title: package-lock.json
url: /cli/v6/configuring-npm/package-lock-json
description: A manifestation of the manifest
- title: shrinkwrap.json
url: /cli/v6/configuring-npm/shrinkwrap-json
description: A publishable lockfile
- title: Using npm
shortName: Using
url: /cli/v6/using-npm
children:
- title: Registry
url: /cli/v6/using-npm/registry
description: The JavaScript Package Registry
- title: Config
url: /cli/v6/using-npm/config
description: About npm configuration
- title: semver
url: /cli/v6/using-npm/semver
description: The semantic versioner for npm
- title: Scope
url: /cli/v6/using-npm/scope
description: Scoped packages
- title: Scripts
url: /cli/v6/using-npm/scripts
description: How npm handles the "scripts" field
- title: Organizations
url: /cli/v6/using-npm/orgs
description: Working with teams & organizations
- title: Developers
url: /cli/v6/using-npm/developers
description: Developer guide
- title: Removal
url: /cli/v6/using-npm/removal
description: Cleaning the slate
- title: Changelog
url: /cli/v6/using-npm/changelog
description: Changelog notes for each version
- title: Version 7.24.2 (Legacy Release)
shortName: v7
url: /cli/v7
default: false
children:
- title: CLI Commands
shortName: Commands
url: /cli/v7/commands
children:
- title: npm
url: /cli/v7/commands/npm
description: JavaScript package manager
- title: npm access
url: /cli/v7/commands/npm-access
description: Set access level on published packages
- title: npm adduser
url: /cli/v7/commands/npm-adduser
description: Add a registry user account
- title: npm audit
url: /cli/v7/commands/npm-audit
description: Run a security audit
- title: npm bin
url: /cli/v7/commands/npm-bin
description: Display npm bin folder
- title: npm bugs
url: /cli/v7/commands/npm-bugs
description: Bugs for a package in a web browser maybe
- title: npm cache
url: /cli/v7/commands/npm-cache
description: Manipulates packages cache
- title: npm ci
url: /cli/v7/commands/npm-ci
description: Install a project with a clean slate
- title: npm completion
url: /cli/v7/commands/npm-completion
description: Tab completion for npm
- title: npm config
url: /cli/v7/commands/npm-config
description: Manage the npm configuration files
- title: npm dedupe
url: /cli/v7/commands/npm-dedupe
description: Reduce duplication
- title: npm deprecate
url: /cli/v7/commands/npm-deprecate
description: Deprecate a version of a package
- title: npm diff
url: /cli/v7/commands/npm-diff
description: The registry diff command
- title: npm dist-tag
url: /cli/v7/commands/npm-dist-tag
description: Modify package distribution tags
- title: npm docs
url: /cli/v7/commands/npm-docs
description: Docs for a package in a web browser maybe
- title: npm doctor
url: /cli/v7/commands/npm-doctor
description: Check your environments
- title: npm edit
url: /cli/v7/commands/npm-edit
description: Edit an installed package
- title: npm exec
url: /cli/v7/commands/npm-exec
description: Run a command from an npm package
- title: npm explain
url: /cli/v7/commands/npm-explain
description: Explain installed packages
- title: npm explore
url: /cli/v7/commands/npm-explore
description: Browse an installed package
- title: npm find-dupes
url: /cli/v7/commands/npm-find-dupes
description: Find duplication in the package tree
- title: npm fund
url: /cli/v7/commands/npm-fund
description: Retrieve funding information
- title: npm help
url: /cli/v7/commands/npm-help
description: Search npm help documentation
- title: npm help-search
url: /cli/v7/commands/npm-help-search
description: Get help on npm
- title: npm hook
url: /cli/v7/commands/npm-hook
description: Manage registry hooks
- title: npm init
url: /cli/v7/commands/npm-init
description: Create a package.json file
- title: npm install
url: /cli/v7/commands/npm-install
description: Install a package
- title: npm install-ci-test
url: /cli/v7/commands/npm-install-ci-test
description: Install a project with a clean slate and run tests
- title: npm install-test
url: /cli/v7/commands/npm-install-test
description: Install package(s) and run tests
- title: npm link
url: /cli/v7/commands/npm-link
description: Symlink a package folder
- title: npm logout
url: /cli/v7/commands/npm-logout
description: Log out of the registry
- title: npm ls
url: /cli/v7/commands/npm-ls
description: List installed packages
- title: npm org
url: /cli/v7/commands/npm-org
description: Manage orgs
- title: npm outdated
url: /cli/v7/commands/npm-outdated
description: Check for outdated packages
- title: npm owner
url: /cli/v7/commands/npm-owner
description: Manage package owners
- title: npm pack
url: /cli/v7/commands/npm-pack
description: Create a tarball from a package
- title: npm ping
url: /cli/v7/commands/npm-ping
description: Ping npm registry
- title: npm pkg
url: /cli/v7/commands/npm-pkg
description: Manages your package.json
- title: npm prefix
url: /cli/v7/commands/npm-prefix
description: Display prefix
- title: npm profile
url: /cli/v7/commands/npm-profile
description: Change settings on your registry profile
- title: npm prune
url: /cli/v7/commands/npm-prune
description: Remove extraneous packages
- title: npm publish
url: /cli/v7/commands/npm-publish
description: Publish a package
- title: npm rebuild
url: /cli/v7/commands/npm-rebuild
description: Rebuild a package
- title: npm repo
url: /cli/v7/commands/npm-repo
description: Open package repository page in the browser
- title: npm restart
url: /cli/v7/commands/npm-restart
description: Restart a package
- title: npm root
url: /cli/v7/commands/npm-root
description: Display npm root
- title: npm run-script
url: /cli/v7/commands/npm-run-script
description: Run arbitrary package scripts
- title: npm search
url: /cli/v7/commands/npm-search
description: Search for packages
- title: npm set-script
url: /cli/v7/commands/npm-set-script
description: Set tasks in the scripts section of package.json
- title: npm shrinkwrap
url: /cli/v7/commands/npm-shrinkwrap
description: Lock down dependency versions for publication
- title: npm star
url: /cli/v7/commands/npm-star
description: Mark your favorite packages
- title: npm stars
url: /cli/v7/commands/npm-stars
description: View packages marked as favorites
- title: npm start
url: /cli/v7/commands/npm-start
description: Start a package
- title: npm stop
url: /cli/v7/commands/npm-stop
description: Stop a package
- title: npm team
url: /cli/v7/commands/npm-team
description: Manage organization teams and team memberships
- title: npm test
url: /cli/v7/commands/npm-test
description: Test a package
- title: npm token
url: /cli/v7/commands/npm-token
description: Manage your authentication tokens
- title: npm uninstall
url: /cli/v7/commands/npm-uninstall
description: Remove a package
- title: npm unpublish
url: /cli/v7/commands/npm-unpublish
description: Remove a package from the registry
- title: npm unstar
url: /cli/v7/commands/npm-unstar
description: Remove an item from your favorite packages
- title: npm update
url: /cli/v7/commands/npm-update
description: Update a package
- title: npm version
url: /cli/v7/commands/npm-version
description: Bump a package version
- title: npm view
url: /cli/v7/commands/npm-view
description: View registry info
- title: npm whoami
url: /cli/v7/commands/npm-whoami
description: Display npm username
- title: npx
url: /cli/v7/commands/npx
description: Run a command from an npm package
- title: Configuring npm
shortName: Configuring
url: /cli/v7/configuring-npm
children:
- title: Install
url: /cli/v7/configuring-npm/install
description: Download and install node and npm
- title: Folders
url: /cli/v7/configuring-npm/folders
description: Folder structures used by npm
- title: .npmrc
url: /cli/v7/configuring-npm/npmrc
description: The npm config files
- title: npm-shrinkwrap.json
url: /cli/v7/configuring-npm/npm-shrinkwrap-json
description: A publishable lockfile
- title: package.json
url: /cli/v7/configuring-npm/package-json
description: Specifics of npm's package.json handling
- title: package-lock.json
url: /cli/v7/configuring-npm/package-lock-json
description: A manifestation of the manifest
- title: Using npm
shortName: Using
url: /cli/v7/using-npm
children:
- title: Registry
url: /cli/v7/using-npm/registry
description: The JavaScript Package Registry
- title: Config
url: /cli/v7/using-npm/config
description: About npm configuration
- title: Scope
url: /cli/v7/using-npm/scope
description: Scoped packages
- title: Scripts
url: /cli/v7/using-npm/scripts
description: How npm handles the "scripts" field
- title: Workspaces
url: /cli/v7/using-npm/workspaces
description: Working with workspaces
- title: Organizations
url: /cli/v7/using-npm/orgs
description: Working with teams & organizations
- title: Developers
url: /cli/v7/using-npm/developers
description: Developer guide
- title: Removal
url: /cli/v7/using-npm/removal
description: Cleaning the slate
- title: Changelog
url: /cli/v7/using-npm/changelog
description: Changelog notes for each version
- title: Version 8.19.3 (Legacy Release)
shortName: v8
url: /cli/v8
default: false
children:
- title: CLI Commands
shortName: Commands
url: /cli/v8/commands
children:
- title: npm
url: /cli/v8/commands/npm
description: JavaScript package manager
- title: npm access
url: /cli/v8/commands/npm-access
description: Set access level on published packages
- title: npm adduser
url: /cli/v8/commands/npm-adduser
description: Add a registry user account
- title: npm audit
url: /cli/v8/commands/npm-audit
description: Run a security audit
- title: npm bin
url: /cli/v8/commands/npm-bin
description: Display npm bin folder
- title: npm bugs
url: /cli/v8/commands/npm-bugs
description: Bugs for a package in a web browser maybe
- title: npm cache
url: /cli/v8/commands/npm-cache
description: Manipulates packages cache
- title: npm ci
url: /cli/v8/commands/npm-ci
description: Install a project with a clean slate
- title: npm completion
url: /cli/v8/commands/npm-completion
description: Tab completion for npm
- title: npm config
url: /cli/v8/commands/npm-config
description: Manage the npm configuration files
- title: npm dedupe
url: /cli/v8/commands/npm-dedupe
description: Reduce duplication
- title: npm deprecate
url: /cli/v8/commands/npm-deprecate
description: Deprecate a version of a package
- title: npm diff
url: /cli/v8/commands/npm-diff
description: The registry diff command
- title: npm dist-tag
url: /cli/v8/commands/npm-dist-tag
description: Modify package distribution tags
- title: npm docs
url: /cli/v8/commands/npm-docs
description: Docs for a package in a web browser maybe
- title: npm doctor
url: /cli/v8/commands/npm-doctor
description: Check your environments
- title: npm edit
url: /cli/v8/commands/npm-edit
description: Edit an installed package
- title: npm exec
url: /cli/v8/commands/npm-exec
description: Run a command from an npm package
- title: npm explain
url: /cli/v8/commands/npm-explain
description: Explain installed packages
- title: npm explore
url: /cli/v8/commands/npm-explore
description: Browse an installed package
- title: npm find-dupes
url: /cli/v8/commands/npm-find-dupes
description: Find duplication in the package tree
- title: npm fund
url: /cli/v8/commands/npm-fund
description: Retrieve funding information
- title: npm help
url: /cli/v8/commands/npm-help
description: Search npm help documentation
- title: npm help-search
url: /cli/v8/commands/npm-help-search
description: Get help on npm
- title: npm hook
url: /cli/v8/commands/npm-hook
description: Manage registry hooks
- title: npm init
url: /cli/v8/commands/npm-init
description: Create a package.json file
- title: npm install
url: /cli/v8/commands/npm-install
description: Install a package
- title: npm install-ci-test
url: /cli/v8/commands/npm-install-ci-test
description: Install a project with a clean slate and run tests
- title: npm install-test
url: /cli/v8/commands/npm-install-test
description: Install package(s) and run tests
- title: npm link
url: /cli/v8/commands/npm-link
description: Symlink a package folder
- title: npm logout
url: /cli/v8/commands/npm-logout
description: Log out of the registry
- title: npm ls
url: /cli/v8/commands/npm-ls
description: List installed packages
- title: npm org
url: /cli/v8/commands/npm-org
description: Manage orgs
- title: npm outdated
url: /cli/v8/commands/npm-outdated
description: Check for outdated packages
- title: npm owner
url: /cli/v8/commands/npm-owner
description: Manage package owners
- title: npm pack
url: /cli/v8/commands/npm-pack
description: Create a tarball from a package
- title: npm ping
url: /cli/v8/commands/npm-ping
description: Ping npm registry
- title: npm pkg
url: /cli/v8/commands/npm-pkg
description: Manages your package.json
- title: npm prefix
url: /cli/v8/commands/npm-prefix
description: Display prefix
- title: npm profile
url: /cli/v8/commands/npm-profile
description: Change settings on your registry profile
- title: npm prune
url: /cli/v8/commands/npm-prune
description: Remove extraneous packages
- title: npm publish
url: /cli/v8/commands/npm-publish
description: Publish a package
- title: npm query
url: /cli/v8/commands/npm-query
description: Retrieve a filtered list of packages
- title: npm rebuild
url: /cli/v8/commands/npm-rebuild
description: Rebuild a package
- title: npm repo
url: /cli/v8/commands/npm-repo
description: Open package repository page in the browser
- title: npm restart
url: /cli/v8/commands/npm-restart
description: Restart a package
- title: npm root
url: /cli/v8/commands/npm-root
description: Display npm root
- title: npm run-script
url: /cli/v8/commands/npm-run-script
description: Run arbitrary package scripts
- title: npm search
url: /cli/v8/commands/npm-search
description: Search for packages
- title: npm set-script
url: /cli/v8/commands/npm-set-script
description: Set tasks in the scripts section of package.json
- title: npm shrinkwrap
url: /cli/v8/commands/npm-shrinkwrap
description: Lock down dependency versions for publication
- title: npm star
url: /cli/v8/commands/npm-star
description: Mark your favorite packages
- title: npm stars
url: /cli/v8/commands/npm-stars
description: View packages marked as favorites
- title: npm start
url: /cli/v8/commands/npm-start
description: Start a package
- title: npm stop
url: /cli/v8/commands/npm-stop
description: Stop a package
- title: npm team
url: /cli/v8/commands/npm-team
description: Manage organization teams and team memberships
- title: npm test
url: /cli/v8/commands/npm-test
description: Test a package
- title: npm token
url: /cli/v8/commands/npm-token
description: Manage your authentication tokens
- title: npm uninstall
url: /cli/v8/commands/npm-uninstall
description: Remove a package
- title: npm unpublish
url: /cli/v8/commands/npm-unpublish
description: Remove a package from the registry
- title: npm unstar
url: /cli/v8/commands/npm-unstar
description: Remove an item from your favorite packages
- title: npm update
url: /cli/v8/commands/npm-update
description: Update a package
- title: npm version
url: /cli/v8/commands/npm-version
description: Bump a package version
- title: npm view
url: /cli/v8/commands/npm-view
description: View registry info
- title: npm whoami
url: /cli/v8/commands/npm-whoami
description: Display npm username
- title: npx
url: /cli/v8/commands/npx
description: Run a command from an npm package
- title: Configuring npm
shortName: Configuring
url: /cli/v8/configuring-npm
children:
- title: Install
url: /cli/v8/configuring-npm/install
description: Download and install node and npm