1/* IMPORTANT 2 * This snapshot file is auto-generated, but designed for humans. 3 * It should be checked into source control and tracked carefully. 4 * Re-generate by setting TAP_SNAPSHOT=1 and running tests. 5 * Make sure to inspect the output below. Do not ignore changes! 6 */ 7'use strict' 8exports[`test/lib/docs.js TAP basic usage > must match snapshot 1`] = ` 9npm <command> 10 11Usage: 12 13npm install install all the dependencies in your project 14npm install <foo> add the <foo> dependency to your project 15npm test run this project's tests 16npm run <foo> run the script named <foo> 17npm <command> -h quick help on <command> 18npm -l display usage info for all commands 19npm help <term> search for help on <term> 20npm help npm more involved overview 21 22All commands: 23 24 25 26Specify configs in the ini-formatted file: 27 {USERCONFIG} 28or on the command line via: npm <command> --key=value 29 30More configuration info: npm help config 31Configuration fields: npm help 7 config 32 33npm@{VERSION} {BASEDIR} 34` 35 36exports[`test/lib/docs.js TAP command list > aliases 1`] = ` 37Object { 38 "add": "install", 39 "add-user": "adduser", 40 "author": "owner", 41 "c": "config", 42 "cit": "install-ci-test", 43 "clean-install": "ci", 44 "clean-install-test": "install-ci-test", 45 "create": "init", 46 "ddp": "dedupe", 47 "dist-tags": "dist-tag", 48 "find": "search", 49 "hlep": "help", 50 "home": "docs", 51 "i": "install", 52 "ic": "ci", 53 "in": "install", 54 "info": "view", 55 "innit": "init", 56 "ins": "install", 57 "inst": "install", 58 "insta": "install", 59 "instal": "install", 60 "install-clean": "ci", 61 "isnt": "install", 62 "isnta": "install", 63 "isntal": "install", 64 "isntall": "install", 65 "isntall-clean": "ci", 66 "issues": "bugs", 67 "it": "install-test", 68 "la": "ll", 69 "list": "ls", 70 "ln": "link", 71 "ogr": "org", 72 "r": "uninstall", 73 "rb": "rebuild", 74 "remove": "uninstall", 75 "rm": "uninstall", 76 "rum": "run-script", 77 "run": "run-script", 78 "s": "search", 79 "se": "search", 80 "show": "view", 81 "sit": "install-ci-test", 82 "t": "test", 83 "tst": "test", 84 "udpate": "update", 85 "un": "uninstall", 86 "unlink": "uninstall", 87 "up": "update", 88 "upgrade": "update", 89 "urn": "run-script", 90 "v": "view", 91 "verison": "version", 92 "why": "explain", 93 "x": "exec", 94} 95` 96 97exports[`test/lib/docs.js TAP command list > commands 1`] = ` 98Array [ 99 "access", 100 "adduser", 101 "audit", 102 "bugs", 103 "cache", 104 "ci", 105 "completion", 106 "config", 107 "dedupe", 108 "deprecate", 109 "diff", 110 "dist-tag", 111 "docs", 112 "doctor", 113 "edit", 114 "exec", 115 "explain", 116 "explore", 117 "find-dupes", 118 "fund", 119 "get", 120 "help", 121 "help-search", 122 "hook", 123 "init", 124 "install", 125 "install-ci-test", 126 "install-test", 127 "link", 128 "ll", 129 "login", 130 "logout", 131 "ls", 132 "org", 133 "outdated", 134 "owner", 135 "pack", 136 "ping", 137 "pkg", 138 "prefix", 139 "profile", 140 "prune", 141 "publish", 142 "query", 143 "rebuild", 144 "repo", 145 "restart", 146 "root", 147 "run-script", 148 "sbom", 149 "search", 150 "set", 151 "shrinkwrap", 152 "star", 153 "stars", 154 "start", 155 "stop", 156 "team", 157 "test", 158 "token", 159 "uninstall", 160 "unpublish", 161 "unstar", 162 "update", 163 "version", 164 "view", 165 "whoami", 166] 167` 168 169exports[`test/lib/docs.js TAP command list > deref 1`] = ` 170Function deref(c) 171` 172 173exports[`test/lib/docs.js TAP config > all definitions 1`] = ` 174#### \`_auth\` 175 176* Default: null 177* Type: null or String 178 179A basic-auth string to use when authenticating against the npm registry. 180This will ONLY be used to authenticate against the npm registry. For other 181registries you will need to scope it like "//other-registry.tld/:_auth" 182 183Warning: This should generally not be set via a command-line option. It is 184safer to use a registry-provided authentication bearer token stored in the 185~/.npmrc file by running \`npm login\`. 186 187 188 189#### \`access\` 190 191* Default: 'public' for new packages, existing packages it will not change the 192 current level 193* Type: null, "restricted", or "public" 194 195If you do not want your scoped package to be publicly viewable (and 196installable) set \`--access=restricted\`. 197 198Unscoped packages can not be set to \`restricted\`. 199 200Note: This defaults to not changing the current access level for existing 201packages. Specifying a value of \`restricted\` or \`public\` during publish will 202change the access for an existing package the same way that \`npm access set 203status\` would. 204 205 206 207#### \`all\` 208 209* Default: false 210* Type: Boolean 211 212When running \`npm outdated\` and \`npm ls\`, setting \`--all\` will show all 213outdated or installed packages, rather than only those directly depended 214upon by the current project. 215 216 217 218#### \`allow-same-version\` 219 220* Default: false 221* Type: Boolean 222 223Prevents throwing an error when \`npm version\` is used to set the new version 224to the same value as the current version. 225 226 227 228#### \`audit\` 229 230* Default: true 231* Type: Boolean 232 233When "true" submit audit reports alongside the current npm command to the 234default registry and all registries configured for scopes. See the 235documentation for [\`npm audit\`](/commands/npm-audit) for details on what is 236submitted. 237 238 239 240#### \`audit-level\` 241 242* Default: null 243* Type: null, "info", "low", "moderate", "high", "critical", or "none" 244 245The minimum level of vulnerability for \`npm audit\` to exit with a non-zero 246exit code. 247 248 249 250#### \`auth-type\` 251 252* Default: "web" 253* Type: "legacy" or "web" 254 255What authentication strategy to use with \`login\`. Note that if an \`otp\` 256config is given, this value will always be set to \`legacy\`. 257 258 259 260#### \`before\` 261 262* Default: null 263* Type: null or Date 264 265If passed to \`npm install\`, will rebuild the npm tree such that only 266versions that were available **on or before** the \`--before\` time get 267installed. If there's no versions available for the current set of direct 268dependencies, the command will error. 269 270If the requested version is a \`dist-tag\` and the given tag does not pass the 271\`--before\` filter, the most recent version less than or equal to that tag 272will be used. For example, \`foo@latest\` might install \`foo@1.2\` even though 273\`latest\` is \`2.0\`. 274 275 276 277#### \`bin-links\` 278 279* Default: true 280* Type: Boolean 281 282Tells npm to create symlinks (or \`.cmd\` shims on Windows) for package 283executables. 284 285Set to false to have it not do this. This can be used to work around the 286fact that some file systems don't support symlinks, even on ostensibly Unix 287systems. 288 289 290 291#### \`browser\` 292 293* Default: OS X: \`"open"\`, Windows: \`"start"\`, Others: \`"xdg-open"\` 294* Type: null, Boolean, or String 295 296The browser that is called by npm commands to open websites. 297 298Set to \`false\` to suppress browser behavior and instead print urls to 299terminal. 300 301Set to \`true\` to use default system URL opener. 302 303 304 305#### \`ca\` 306 307* Default: null 308* Type: null or String (can be set multiple times) 309 310The Certificate Authority signing certificate that is trusted for SSL 311connections to the registry. Values should be in PEM format (Windows calls 312it "Base-64 encoded X.509 (.CER)") with newlines replaced by the string 313"\\n". For example: 314 315\`\`\`ini 316ca="-----BEGIN CERTIFICATE-----\\nXXXX\\nXXXX\\n-----END CERTIFICATE-----" 317\`\`\` 318 319Set to \`null\` to only allow "known" registrars, or to a specific CA cert to 320trust only that specific signing authority. 321 322Multiple CAs can be trusted by specifying an array of certificates: 323 324\`\`\`ini 325ca[]="..." 326ca[]="..." 327\`\`\` 328 329See also the \`strict-ssl\` config. 330 331 332 333#### \`cache\` 334 335* Default: Windows: \`%LocalAppData%\\npm-cache\`, Posix: \`~/.npm\` 336* Type: Path 337 338The location of npm's cache directory. 339 340 341 342#### \`cafile\` 343 344* Default: null 345* Type: Path 346 347A path to a file containing one or multiple Certificate Authority signing 348certificates. Similar to the \`ca\` setting, but allows for multiple CA's, as 349well as for the CA information to be stored in a file on disk. 350 351 352 353#### \`call\` 354 355* Default: "" 356* Type: String 357 358Optional companion option for \`npm exec\`, \`npx\` that allows for specifying a 359custom command to be run along with the installed packages. 360 361\`\`\`bash 362npm exec --package yo --package generator-node --call "yo node" 363\`\`\` 364 365 366 367#### \`cidr\` 368 369* Default: null 370* Type: null or String (can be set multiple times) 371 372This is a list of CIDR address to be used when configuring limited access 373tokens with the \`npm token create\` command. 374 375 376 377#### \`color\` 378 379* Default: true unless the NO_COLOR environ is set to something other than '0' 380* Type: "always" or Boolean 381 382If false, never shows colors. If \`"always"\` then always shows colors. If 383true, then only prints color codes for tty file descriptors. 384 385 386 387#### \`commit-hooks\` 388 389* Default: true 390* Type: Boolean 391 392Run git commit hooks when using the \`npm version\` command. 393 394 395 396#### \`cpu\` 397 398* Default: null 399* Type: null or String 400 401Override CPU architecture of native modules to install. Acceptable values 402are same as \`cpu\` field of package.json, which comes from \`process.arch\`. 403 404 405 406#### \`depth\` 407 408* Default: \`Infinity\` if \`--all\` is set, otherwise \`1\` 409* Type: null or Number 410 411The depth to go when recursing packages for \`npm ls\`. 412 413If not set, \`npm ls\` will show only the immediate dependencies of the root 414project. If \`--all\` is set, then npm will show all dependencies by default. 415 416 417 418#### \`description\` 419 420* Default: true 421* Type: Boolean 422 423Show the description in \`npm search\` 424 425 426 427#### \`diff\` 428 429* Default: 430* Type: String (can be set multiple times) 431 432Define arguments to compare in \`npm diff\`. 433 434 435 436#### \`diff-dst-prefix\` 437 438* Default: "b/" 439* Type: String 440 441Destination prefix to be used in \`npm diff\` output. 442 443 444 445#### \`diff-ignore-all-space\` 446 447* Default: false 448* Type: Boolean 449 450Ignore whitespace when comparing lines in \`npm diff\`. 451 452 453 454#### \`diff-name-only\` 455 456* Default: false 457* Type: Boolean 458 459Prints only filenames when using \`npm diff\`. 460 461 462 463#### \`diff-no-prefix\` 464 465* Default: false 466* Type: Boolean 467 468Do not show any source or destination prefix in \`npm diff\` output. 469 470Note: this causes \`npm diff\` to ignore the \`--diff-src-prefix\` and 471\`--diff-dst-prefix\` configs. 472 473 474 475#### \`diff-src-prefix\` 476 477* Default: "a/" 478* Type: String 479 480Source prefix to be used in \`npm diff\` output. 481 482 483 484#### \`diff-text\` 485 486* Default: false 487* Type: Boolean 488 489Treat all files as text in \`npm diff\`. 490 491 492 493#### \`diff-unified\` 494 495* Default: 3 496* Type: Number 497 498The number of lines of context to print in \`npm diff\`. 499 500 501 502#### \`dry-run\` 503 504* Default: false 505* Type: Boolean 506 507Indicates that you don't want npm to make any changes and that it should 508only report what it would have done. This can be passed into any of the 509commands that modify your local installation, eg, \`install\`, \`update\`, 510\`dedupe\`, \`uninstall\`, as well as \`pack\` and \`publish\`. 511 512Note: This is NOT honored by other network related commands, eg \`dist-tags\`, 513\`owner\`, etc. 514 515 516 517#### \`editor\` 518 519* Default: The EDITOR or VISUAL environment variables, or 520 '%SYSTEMROOT%\\notepad.exe' on Windows, or 'vi' on Unix systems 521* Type: String 522 523The command to run for \`npm edit\` and \`npm config edit\`. 524 525 526 527#### \`engine-strict\` 528 529* Default: false 530* Type: Boolean 531 532If set to true, then npm will stubbornly refuse to install (or even consider 533installing) any package that claims to not be compatible with the current 534Node.js version. 535 536This can be overridden by setting the \`--force\` flag. 537 538 539 540#### \`expect-result-count\` 541 542* Default: null 543* Type: null or Number 544 545Tells to expect a specific number of results from the command. 546 547This config can not be used with: \`expect-results\` 548 549#### \`expect-results\` 550 551* Default: null 552* Type: null or Boolean 553 554Tells npm whether or not to expect results from the command. Can be either 555true (expect some results) or false (expect no results). 556 557This config can not be used with: \`expect-result-count\` 558 559#### \`fetch-retries\` 560 561* Default: 2 562* Type: Number 563 564The "retries" config for the \`retry\` module to use when fetching packages 565from the registry. 566 567npm will retry idempotent read requests to the registry in the case of 568network failures or 5xx HTTP errors. 569 570 571 572#### \`fetch-retry-factor\` 573 574* Default: 10 575* Type: Number 576 577The "factor" config for the \`retry\` module to use when fetching packages. 578 579 580 581#### \`fetch-retry-maxtimeout\` 582 583* Default: 60000 (1 minute) 584* Type: Number 585 586The "maxTimeout" config for the \`retry\` module to use when fetching 587packages. 588 589 590 591#### \`fetch-retry-mintimeout\` 592 593* Default: 10000 (10 seconds) 594* Type: Number 595 596The "minTimeout" config for the \`retry\` module to use when fetching 597packages. 598 599 600 601#### \`fetch-timeout\` 602 603* Default: 300000 (5 minutes) 604* Type: Number 605 606The maximum amount of time to wait for HTTP requests to complete. 607 608 609 610#### \`force\` 611 612* Default: false 613* Type: Boolean 614 615Removes various protections against unfortunate side effects, common 616mistakes, unnecessary performance degradation, and malicious input. 617 618* Allow clobbering non-npm files in global installs. 619* Allow the \`npm version\` command to work on an unclean git repository. 620* Allow deleting the cache folder with \`npm cache clean\`. 621* Allow installing packages that have an \`engines\` declaration requiring a 622 different version of npm. 623* Allow installing packages that have an \`engines\` declaration requiring a 624 different version of \`node\`, even if \`--engine-strict\` is enabled. 625* Allow \`npm audit fix\` to install modules outside your stated dependency 626 range (including SemVer-major changes). 627* Allow unpublishing all versions of a published package. 628* Allow conflicting peerDependencies to be installed in the root project. 629* Implicitly set \`--yes\` during \`npm init\`. 630* Allow clobbering existing values in \`npm pkg\` 631* Allow unpublishing of entire packages (not just a single version). 632 633If you don't have a clear idea of what you want to do, it is strongly 634recommended that you do not use this option! 635 636 637 638#### \`foreground-scripts\` 639 640* Default: \`false\` unless when using \`npm pack\` or \`npm publish\` where it 641 defaults to \`true\` 642* Type: Boolean 643 644Run all build scripts (ie, \`preinstall\`, \`install\`, and \`postinstall\`) 645scripts for installed packages in the foreground process, sharing standard 646input, output, and error with the main npm process. 647 648Note that this will generally make installs run slower, and be much noisier, 649but can be useful for debugging. 650 651 652 653#### \`format-package-lock\` 654 655* Default: true 656* Type: Boolean 657 658Format \`package-lock.json\` or \`npm-shrinkwrap.json\` as a human readable 659file. 660 661 662 663#### \`fund\` 664 665* Default: true 666* Type: Boolean 667 668When "true" displays the message at the end of each \`npm install\` 669acknowledging the number of dependencies looking for funding. See [\`npm 670fund\`](/commands/npm-fund) for details. 671 672 673 674#### \`git\` 675 676* Default: "git" 677* Type: String 678 679The command to use for git commands. If git is installed on the computer, 680but is not in the \`PATH\`, then set this to the full path to the git binary. 681 682 683 684#### \`git-tag-version\` 685 686* Default: true 687* Type: Boolean 688 689Tag the commit when using the \`npm version\` command. Setting this to false 690results in no commit being made at all. 691 692 693 694#### \`global\` 695 696* Default: false 697* Type: Boolean 698 699Operates in "global" mode, so that packages are installed into the \`prefix\` 700folder instead of the current working directory. See 701[folders](/configuring-npm/folders) for more on the differences in behavior. 702 703* packages are installed into the \`{prefix}/lib/node_modules\` folder, instead 704 of the current working directory. 705* bin files are linked to \`{prefix}/bin\` 706* man pages are linked to \`{prefix}/share/man\` 707 708 709 710#### \`globalconfig\` 711 712* Default: The global --prefix setting plus 'etc/npmrc'. For example, 713 '/usr/local/etc/npmrc' 714* Type: Path 715 716The config file to read for global config options. 717 718 719 720#### \`heading\` 721 722* Default: "npm" 723* Type: String 724 725The string that starts all the debugging log output. 726 727 728 729#### \`https-proxy\` 730 731* Default: null 732* Type: null or URL 733 734A proxy to use for outgoing https requests. If the \`HTTPS_PROXY\` or 735\`https_proxy\` or \`HTTP_PROXY\` or \`http_proxy\` environment variables are set, 736proxy settings will be honored by the underlying \`make-fetch-happen\` 737library. 738 739 740 741#### \`if-present\` 742 743* Default: false 744* Type: Boolean 745 746If true, npm will not exit with an error code when \`run-script\` is invoked 747for a script that isn't defined in the \`scripts\` section of \`package.json\`. 748This option can be used when it's desirable to optionally run a script when 749it's present and fail if the script fails. This is useful, for example, when 750running scripts that may only apply for some builds in an otherwise generic 751CI setup. 752 753This value is not exported to the environment for child processes. 754 755#### \`ignore-scripts\` 756 757* Default: false 758* Type: Boolean 759 760If true, npm does not run scripts specified in package.json files. 761 762Note that commands explicitly intended to run a particular script, such as 763\`npm start\`, \`npm stop\`, \`npm restart\`, \`npm test\`, and \`npm run-script\` 764will still run their intended script if \`ignore-scripts\` is set, but they 765will *not* run any pre- or post-scripts. 766 767 768 769#### \`include\` 770 771* Default: 772* Type: "prod", "dev", "optional", or "peer" (can be set multiple times) 773 774Option that allows for defining which types of dependencies to install. 775 776This is the inverse of \`--omit=<type>\`. 777 778Dependency types specified in \`--include\` will not be omitted, regardless of 779the order in which omit/include are specified on the command-line. 780 781 782 783#### \`include-staged\` 784 785* Default: false 786* Type: Boolean 787 788Allow installing "staged" published packages, as defined by [npm RFC PR 789#92](https://github.com/npm/rfcs/pull/92). 790 791This is experimental, and not implemented by the npm public registry. 792 793 794 795#### \`include-workspace-root\` 796 797* Default: false 798* Type: Boolean 799 800Include the workspace root when workspaces are enabled for a command. 801 802When false, specifying individual workspaces via the \`workspace\` config, or 803all workspaces via the \`workspaces\` flag, will cause npm to operate only on 804the specified workspaces, and not on the root project. 805 806This value is not exported to the environment for child processes. 807 808#### \`init-author-email\` 809 810* Default: "" 811* Type: String 812 813The value \`npm init\` should use by default for the package author's email. 814 815 816 817#### \`init-author-name\` 818 819* Default: "" 820* Type: String 821 822The value \`npm init\` should use by default for the package author's name. 823 824 825 826#### \`init-author-url\` 827 828* Default: "" 829* Type: "" or URL 830 831The value \`npm init\` should use by default for the package author's 832homepage. 833 834 835 836#### \`init-license\` 837 838* Default: "ISC" 839* Type: String 840 841The value \`npm init\` should use by default for the package license. 842 843 844 845#### \`init-module\` 846 847* Default: "~/.npm-init.js" 848* Type: Path 849 850A module that will be loaded by the \`npm init\` command. See the 851documentation for the 852[init-package-json](https://github.com/npm/init-package-json) module for 853more information, or [npm init](/commands/npm-init). 854 855 856 857#### \`init-version\` 858 859* Default: "1.0.0" 860* Type: SemVer string 861 862The value that \`npm init\` should use by default for the package version 863number, if not already set in package.json. 864 865 866 867#### \`install-links\` 868 869* Default: false 870* Type: Boolean 871 872When set file: protocol dependencies will be packed and installed as regular 873dependencies instead of creating a symlink. This option has no effect on 874workspaces. 875 876 877 878#### \`install-strategy\` 879 880* Default: "hoisted" 881* Type: "hoisted", "nested", "shallow", or "linked" 882 883Sets the strategy for installing packages in node_modules. hoisted 884(default): Install non-duplicated in top-level, and duplicated as necessary 885within directory structure. nested: (formerly --legacy-bundling) install in 886place, no hoisting. shallow (formerly --global-style) only install direct 887deps at top-level. linked: (experimental) install in node_modules/.store, 888link in place, unhoisted. 889 890 891 892#### \`json\` 893 894* Default: false 895* Type: Boolean 896 897Whether or not to output JSON data, rather than the normal output. 898 899* In \`npm pkg set\` it enables parsing set values with JSON.parse() before 900 saving them to your \`package.json\`. 901 902Not supported by all npm commands. 903 904 905 906#### \`legacy-peer-deps\` 907 908* Default: false 909* Type: Boolean 910 911Causes npm to completely ignore \`peerDependencies\` when building a package 912tree, as in npm versions 3 through 6. 913 914If a package cannot be installed because of overly strict \`peerDependencies\` 915that collide, it provides a way to move forward resolving the situation. 916 917This differs from \`--omit=peer\`, in that \`--omit=peer\` will avoid unpacking 918\`peerDependencies\` on disk, but will still design a tree such that 919\`peerDependencies\` _could_ be unpacked in a correct place. 920 921Use of \`legacy-peer-deps\` is not recommended, as it will not enforce the 922\`peerDependencies\` contract that meta-dependencies may rely on. 923 924 925 926#### \`libc\` 927 928* Default: null 929* Type: null or String 930 931Override libc of native modules to install. Acceptable values are same as 932\`libc\` field of package.json 933 934 935 936#### \`link\` 937 938* Default: false 939* Type: Boolean 940 941Used with \`npm ls\`, limiting output to only those packages that are linked. 942 943 944 945#### \`local-address\` 946 947* Default: null 948* Type: IP Address 949 950The IP address of the local interface to use when making connections to the 951npm registry. Must be IPv4 in versions of Node prior to 0.12. 952 953 954 955#### \`location\` 956 957* Default: "user" unless \`--global\` is passed, which will also set this value 958 to "global" 959* Type: "global", "user", or "project" 960 961When passed to \`npm config\` this refers to which config file to use. 962 963When set to "global" mode, packages are installed into the \`prefix\` folder 964instead of the current working directory. See 965[folders](/configuring-npm/folders) for more on the differences in behavior. 966 967* packages are installed into the \`{prefix}/lib/node_modules\` folder, instead 968 of the current working directory. 969* bin files are linked to \`{prefix}/bin\` 970* man pages are linked to \`{prefix}/share/man\` 971 972 973 974#### \`lockfile-version\` 975 976* Default: Version 3 if no lockfile, auto-converting v1 lockfiles to v3, 977 otherwise maintain current lockfile version. 978* Type: null, 1, 2, 3, "1", "2", or "3" 979 980Set the lockfile format version to be used in package-lock.json and 981npm-shrinkwrap-json files. Possible options are: 982 9831: The lockfile version used by npm versions 5 and 6. Lacks some data that 984is used during the install, resulting in slower and possibly less 985deterministic installs. Prevents lockfile churn when interoperating with 986older npm versions. 987 9882: The default lockfile version used by npm version 7 and 8. Includes both 989the version 1 lockfile data and version 3 lockfile data, for maximum 990determinism and interoperability, at the expense of more bytes on disk. 991 9923: Only the new lockfile information introduced in npm version 7. Smaller on 993disk than lockfile version 2, but not interoperable with older npm versions. 994Ideal if all users are on npm version 7 and higher. 995 996 997 998#### \`loglevel\` 999 1000* Default: "notice" 1001* Type: "silent", "error", "warn", "notice", "http", "info", "verbose", or 1002 "silly" 1003 1004What level of logs to report. All logs are written to a debug log, with the 1005path to that file printed if the execution of a command fails. 1006 1007Any logs of a higher level than the setting are shown. The default is 1008"notice". 1009 1010See also the \`foreground-scripts\` config. 1011 1012 1013 1014#### \`logs-dir\` 1015 1016* Default: A directory named \`_logs\` inside the cache 1017* Type: null or Path 1018 1019The location of npm's log directory. See [\`npm logging\`](/using-npm/logging) 1020for more information. 1021 1022 1023 1024#### \`logs-max\` 1025 1026* Default: 10 1027* Type: Number 1028 1029The maximum number of log files to store. 1030 1031If set to 0, no log files will be written for the current run. 1032 1033 1034 1035#### \`long\` 1036 1037* Default: false 1038* Type: Boolean 1039 1040Show extended information in \`ls\`, \`search\`, and \`help-search\`. 1041 1042 1043 1044#### \`maxsockets\` 1045 1046* Default: 15 1047* Type: Number 1048 1049The maximum number of connections to use per origin (protocol/host/port 1050combination). 1051 1052 1053 1054#### \`message\` 1055 1056* Default: "%s" 1057* Type: String 1058 1059Commit message which is used by \`npm version\` when creating version commit. 1060 1061Any "%s" in the message will be replaced with the version number. 1062 1063 1064 1065#### \`node-options\` 1066 1067* Default: null 1068* Type: null or String 1069 1070Options to pass through to Node.js via the \`NODE_OPTIONS\` environment 1071variable. This does not impact how npm itself is executed but it does impact 1072how lifecycle scripts are called. 1073 1074 1075 1076#### \`noproxy\` 1077 1078* Default: The value of the NO_PROXY environment variable 1079* Type: String (can be set multiple times) 1080 1081Domain extensions that should bypass any proxies. 1082 1083Also accepts a comma-delimited string. 1084 1085 1086 1087#### \`offline\` 1088 1089* Default: false 1090* Type: Boolean 1091 1092Force offline mode: no network requests will be done during install. To 1093allow the CLI to fill in missing cache data, see \`--prefer-offline\`. 1094 1095 1096 1097#### \`omit\` 1098 1099* Default: 'dev' if the \`NODE_ENV\` environment variable is set to 1100 'production', otherwise empty. 1101* Type: "dev", "optional", or "peer" (can be set multiple times) 1102 1103Dependency types to omit from the installation tree on disk. 1104 1105Note that these dependencies _are_ still resolved and added to the 1106\`package-lock.json\` or \`npm-shrinkwrap.json\` file. They are just not 1107physically installed on disk. 1108 1109If a package type appears in both the \`--include\` and \`--omit\` lists, then 1110it will be included. 1111 1112If the resulting omit list includes \`'dev'\`, then the \`NODE_ENV\` environment 1113variable will be set to \`'production'\` for all lifecycle scripts. 1114 1115 1116 1117#### \`omit-lockfile-registry-resolved\` 1118 1119* Default: false 1120* Type: Boolean 1121 1122This option causes npm to create lock files without a \`resolved\` key for 1123registry dependencies. Subsequent installs will need to resolve tarball 1124endpoints with the configured registry, likely resulting in a longer install 1125time. 1126 1127 1128 1129#### \`os\` 1130 1131* Default: null 1132* Type: null or String 1133 1134Override OS of native modules to install. Acceptable values are same as \`os\` 1135field of package.json, which comes from \`process.platform\`. 1136 1137 1138 1139#### \`otp\` 1140 1141* Default: null 1142* Type: null or String 1143 1144This is a one-time password from a two-factor authenticator. It's needed 1145when publishing or changing package permissions with \`npm access\`. 1146 1147If not set, and a registry response fails with a challenge for a one-time 1148password, npm will prompt on the command line for one. 1149 1150 1151 1152#### \`pack-destination\` 1153 1154* Default: "." 1155* Type: String 1156 1157Directory in which \`npm pack\` will save tarballs. 1158 1159 1160 1161#### \`package\` 1162 1163* Default: 1164* Type: String (can be set multiple times) 1165 1166The package or packages to install for [\`npm exec\`](/commands/npm-exec) 1167 1168 1169 1170#### \`package-lock\` 1171 1172* Default: true 1173* Type: Boolean 1174 1175If set to false, then ignore \`package-lock.json\` files when installing. This 1176will also prevent _writing_ \`package-lock.json\` if \`save\` is true. 1177 1178 1179 1180#### \`package-lock-only\` 1181 1182* Default: false 1183* Type: Boolean 1184 1185If set to true, the current operation will only use the \`package-lock.json\`, 1186ignoring \`node_modules\`. 1187 1188For \`update\` this means only the \`package-lock.json\` will be updated, 1189instead of checking \`node_modules\` and downloading dependencies. 1190 1191For \`list\` this means the output will be based on the tree described by the 1192\`package-lock.json\`, rather than the contents of \`node_modules\`. 1193 1194 1195 1196#### \`parseable\` 1197 1198* Default: false 1199* Type: Boolean 1200 1201Output parseable results from commands that write to standard output. For 1202\`npm search\`, this will be tab-separated table format. 1203 1204 1205 1206#### \`prefer-dedupe\` 1207 1208* Default: false 1209* Type: Boolean 1210 1211Prefer to deduplicate packages if possible, rather than choosing a newer 1212version of a dependency. 1213 1214 1215 1216#### \`prefer-offline\` 1217 1218* Default: false 1219* Type: Boolean 1220 1221If true, staleness checks for cached data will be bypassed, but missing data 1222will be requested from the server. To force full offline mode, use 1223\`--offline\`. 1224 1225 1226 1227#### \`prefer-online\` 1228 1229* Default: false 1230* Type: Boolean 1231 1232If true, staleness checks for cached data will be forced, making the CLI 1233look for updates immediately even for fresh package data. 1234 1235 1236 1237#### \`prefix\` 1238 1239* Default: In global mode, the folder where the node executable is installed. 1240 Otherwise, the nearest parent folder containing either a package.json file 1241 or a node_modules folder. 1242* Type: Path 1243 1244The location to install global items. If set on the command line, then it 1245forces non-global commands to run in the specified folder. 1246 1247 1248 1249#### \`preid\` 1250 1251* Default: "" 1252* Type: String 1253 1254The "prerelease identifier" to use as a prefix for the "prerelease" part of 1255a semver. Like the \`rc\` in \`1.2.0-rc.8\`. 1256 1257 1258 1259#### \`progress\` 1260 1261* Default: \`true\` unless running in a known CI system 1262* Type: Boolean 1263 1264When set to \`true\`, npm will display a progress bar during time intensive 1265operations, if \`process.stderr\` is a TTY. 1266 1267Set to \`false\` to suppress the progress bar. 1268 1269 1270 1271#### \`provenance\` 1272 1273* Default: false 1274* Type: Boolean 1275 1276When publishing from a supported cloud CI/CD system, the package will be 1277publicly linked to where it was built and published from. 1278 1279This config can not be used with: \`provenance-file\` 1280 1281#### \`provenance-file\` 1282 1283* Default: null 1284* Type: Path 1285 1286When publishing, the provenance bundle at the given path will be used. 1287 1288This config can not be used with: \`provenance\` 1289 1290#### \`proxy\` 1291 1292* Default: null 1293* Type: null, false, or URL 1294 1295A proxy to use for outgoing http requests. If the \`HTTP_PROXY\` or 1296\`http_proxy\` environment variables are set, proxy settings will be honored 1297by the underlying \`request\` library. 1298 1299 1300 1301#### \`read-only\` 1302 1303* Default: false 1304* Type: Boolean 1305 1306This is used to mark a token as unable to publish when configuring limited 1307access tokens with the \`npm token create\` command. 1308 1309 1310 1311#### \`rebuild-bundle\` 1312 1313* Default: true 1314* Type: Boolean 1315 1316Rebuild bundled dependencies after installation. 1317 1318 1319 1320#### \`registry\` 1321 1322* Default: "https://registry.npmjs.org/" 1323* Type: URL 1324 1325The base URL of the npm registry. 1326 1327 1328 1329#### \`replace-registry-host\` 1330 1331* Default: "npmjs" 1332* Type: "npmjs", "never", "always", or String 1333 1334Defines behavior for replacing the registry host in a lockfile with the 1335configured registry. 1336 1337The default behavior is to replace package dist URLs from the default 1338registry (https://registry.npmjs.org) to the configured registry. If set to 1339"never", then use the registry value. If set to "always", then replace the 1340registry host with the configured host every time. 1341 1342You may also specify a bare hostname (e.g., "registry.npmjs.org"). 1343 1344 1345 1346#### \`save\` 1347 1348* Default: \`true\` unless when using \`npm update\` where it defaults to \`false\` 1349* Type: Boolean 1350 1351Save installed packages to a \`package.json\` file as dependencies. 1352 1353When used with the \`npm rm\` command, removes the dependency from 1354\`package.json\`. 1355 1356Will also prevent writing to \`package-lock.json\` if set to \`false\`. 1357 1358 1359 1360#### \`save-bundle\` 1361 1362* Default: false 1363* Type: Boolean 1364 1365If a package would be saved at install time by the use of \`--save\`, 1366\`--save-dev\`, or \`--save-optional\`, then also put it in the 1367\`bundleDependencies\` list. 1368 1369Ignored if \`--save-peer\` is set, since peerDependencies cannot be bundled. 1370 1371 1372 1373#### \`save-dev\` 1374 1375* Default: false 1376* Type: Boolean 1377 1378Save installed packages to a package.json file as \`devDependencies\`. 1379 1380 1381 1382#### \`save-exact\` 1383 1384* Default: false 1385* Type: Boolean 1386 1387Dependencies saved to package.json will be configured with an exact version 1388rather than using npm's default semver range operator. 1389 1390 1391 1392#### \`save-optional\` 1393 1394* Default: false 1395* Type: Boolean 1396 1397Save installed packages to a package.json file as \`optionalDependencies\`. 1398 1399 1400 1401#### \`save-peer\` 1402 1403* Default: false 1404* Type: Boolean 1405 1406Save installed packages to a package.json file as \`peerDependencies\` 1407 1408 1409 1410#### \`save-prefix\` 1411 1412* Default: "^" 1413* Type: String 1414 1415Configure how versions of packages installed to a package.json file via 1416\`--save\` or \`--save-dev\` get prefixed. 1417 1418For example if a package has version \`1.2.3\`, by default its version is set 1419to \`^1.2.3\` which allows minor upgrades for that package, but after \`npm 1420config set save-prefix='~'\` it would be set to \`~1.2.3\` which only allows 1421patch upgrades. 1422 1423 1424 1425#### \`save-prod\` 1426 1427* Default: false 1428* Type: Boolean 1429 1430Save installed packages into \`dependencies\` specifically. This is useful if 1431a package already exists in \`devDependencies\` or \`optionalDependencies\`, but 1432you want to move it to be a non-optional production dependency. 1433 1434This is the default behavior if \`--save\` is true, and neither \`--save-dev\` 1435or \`--save-optional\` are true. 1436 1437 1438 1439#### \`sbom-format\` 1440 1441* Default: null 1442* Type: "cyclonedx" or "spdx" 1443 1444SBOM format to use when generating SBOMs. 1445 1446 1447 1448#### \`sbom-type\` 1449 1450* Default: "library" 1451* Type: "library", "application", or "framework" 1452 1453The type of package described by the generated SBOM. For SPDX, this is the 1454value for the \`primaryPackagePurpose\` field. For CycloneDX, this is the 1455value for the \`type\` field. 1456 1457 1458 1459#### \`scope\` 1460 1461* Default: the scope of the current project, if any, or "" 1462* Type: String 1463 1464Associate an operation with a scope for a scoped registry. 1465 1466Useful when logging in to or out of a private registry: 1467 1468\`\`\` 1469# log in, linking the scope to the custom registry 1470npm login --scope=@mycorp --registry=https://registry.mycorp.com 1471 1472# log out, removing the link and the auth token 1473npm logout --scope=@mycorp 1474\`\`\` 1475 1476This will cause \`@mycorp\` to be mapped to the registry for future 1477installation of packages specified according to the pattern 1478\`@mycorp/package\`. 1479 1480This will also cause \`npm init\` to create a scoped package. 1481 1482\`\`\` 1483# accept all defaults, and create a package named "@foo/whatever", 1484# instead of just named "whatever" 1485npm init --scope=@foo --yes 1486\`\`\` 1487 1488 1489 1490#### \`script-shell\` 1491 1492* Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows 1493* Type: null or String 1494 1495The shell to use for scripts run with the \`npm exec\`, \`npm run\` and \`npm 1496init <package-spec>\` commands. 1497 1498 1499 1500#### \`searchexclude\` 1501 1502* Default: "" 1503* Type: String 1504 1505Space-separated options that limit the results from search. 1506 1507 1508 1509#### \`searchlimit\` 1510 1511* Default: 20 1512* Type: Number 1513 1514Number of items to limit search results to. Will not apply at all to legacy 1515searches. 1516 1517 1518 1519#### \`searchopts\` 1520 1521* Default: "" 1522* Type: String 1523 1524Space-separated options that are always passed to search. 1525 1526 1527 1528#### \`searchstaleness\` 1529 1530* Default: 900 1531* Type: Number 1532 1533The age of the cache, in seconds, before another registry request is made if 1534using legacy search endpoint. 1535 1536 1537 1538#### \`shell\` 1539 1540* Default: SHELL environment variable, or "bash" on Posix, or "cmd.exe" on 1541 Windows 1542* Type: String 1543 1544The shell to run for the \`npm explore\` command. 1545 1546 1547 1548#### \`sign-git-commit\` 1549 1550* Default: false 1551* Type: Boolean 1552 1553If set to true, then the \`npm version\` command will commit the new package 1554version using \`-S\` to add a signature. 1555 1556Note that git requires you to have set up GPG keys in your git configs for 1557this to work properly. 1558 1559 1560 1561#### \`sign-git-tag\` 1562 1563* Default: false 1564* Type: Boolean 1565 1566If set to true, then the \`npm version\` command will tag the version using 1567\`-s\` to add a signature. 1568 1569Note that git requires you to have set up GPG keys in your git configs for 1570this to work properly. 1571 1572 1573 1574#### \`strict-peer-deps\` 1575 1576* Default: false 1577* Type: Boolean 1578 1579If set to \`true\`, and \`--legacy-peer-deps\` is not set, then _any_ 1580conflicting \`peerDependencies\` will be treated as an install failure, even 1581if npm could reasonably guess the appropriate resolution based on non-peer 1582dependency relationships. 1583 1584By default, conflicting \`peerDependencies\` deep in the dependency graph will 1585be resolved using the nearest non-peer dependency specification, even if 1586doing so will result in some packages receiving a peer dependency outside 1587the range set in their package's \`peerDependencies\` object. 1588 1589When such an override is performed, a warning is printed, explaining the 1590conflict and the packages involved. If \`--strict-peer-deps\` is set, then 1591this warning is treated as a failure. 1592 1593 1594 1595#### \`strict-ssl\` 1596 1597* Default: true 1598* Type: Boolean 1599 1600Whether or not to do SSL key validation when making requests to the registry 1601via https. 1602 1603See also the \`ca\` config. 1604 1605 1606 1607#### \`tag\` 1608 1609* Default: "latest" 1610* Type: String 1611 1612If you ask npm to install a package and don't tell it a specific version, 1613then it will install the specified tag. 1614 1615Also the tag that is added to the package@version specified by the \`npm tag\` 1616command, if no explicit tag is given. 1617 1618When used by the \`npm diff\` command, this is the tag used to fetch the 1619tarball that will be compared with the local files by default. 1620 1621 1622 1623#### \`tag-version-prefix\` 1624 1625* Default: "v" 1626* Type: String 1627 1628If set, alters the prefix used when tagging a new version when performing a 1629version increment using \`npm version\`. To remove the prefix altogether, set 1630it to the empty string: \`""\`. 1631 1632Because other tools may rely on the convention that npm version tags look 1633like \`v1.0.0\`, _only use this property if it is absolutely necessary_. In 1634particular, use care when overriding this setting for public packages. 1635 1636 1637 1638#### \`timing\` 1639 1640* Default: false 1641* Type: Boolean 1642 1643If true, writes timing information to a process specific json file in the 1644cache or \`logs-dir\`. The file name ends with \`-timing.json\`. 1645 1646You can quickly view it with this [json](https://npm.im/json) command line: 1647\`cat ~/.npm/_logs/*-timing.json | npm exec -- json -g\`. 1648 1649Timing information will also be reported in the terminal. To suppress this 1650while still writing the timing file, use \`--silent\`. 1651 1652 1653 1654#### \`umask\` 1655 1656* Default: 0 1657* Type: Octal numeric string in range 0000..0777 (0..511) 1658 1659The "umask" value to use when setting the file creation mode on files and 1660folders. 1661 1662Folders and executables are given a mode which is \`0o777\` masked against 1663this value. Other files are given a mode which is \`0o666\` masked against 1664this value. 1665 1666Note that the underlying system will _also_ apply its own umask value to 1667files and folders that are created, and npm does not circumvent this, but 1668rather adds the \`--umask\` config to it. 1669 1670Thus, the effective default umask value on most POSIX systems is 0o22, 1671meaning that folders and executables are created with a mode of 0o755 and 1672other files are created with a mode of 0o644. 1673 1674 1675 1676#### \`unicode\` 1677 1678* Default: false on windows, true on mac/unix systems with a unicode locale, 1679 as defined by the \`LC_ALL\`, \`LC_CTYPE\`, or \`LANG\` environment variables. 1680* Type: Boolean 1681 1682When set to true, npm uses unicode characters in the tree output. When 1683false, it uses ascii characters instead of unicode glyphs. 1684 1685 1686 1687#### \`update-notifier\` 1688 1689* Default: true 1690* Type: Boolean 1691 1692Set to false to suppress the update notification when using an older version 1693of npm than the latest. 1694 1695 1696 1697#### \`usage\` 1698 1699* Default: false 1700* Type: Boolean 1701 1702Show short usage output about the command specified. 1703 1704 1705 1706#### \`user-agent\` 1707 1708* Default: "npm/{npm-version} node/{node-version} {platform} {arch} 1709 workspaces/{workspaces} {ci}" 1710* Type: String 1711 1712Sets the User-Agent request header. The following fields are replaced with 1713their actual counterparts: 1714 1715* \`{npm-version}\` - The npm version in use 1716* \`{node-version}\` - The Node.js version in use 1717* \`{platform}\` - The value of \`process.platform\` 1718* \`{arch}\` - The value of \`process.arch\` 1719* \`{workspaces}\` - Set to \`true\` if the \`workspaces\` or \`workspace\` options 1720 are set. 1721* \`{ci}\` - The value of the \`ci-name\` config, if set, prefixed with \`ci/\`, or 1722 an empty string if \`ci-name\` is empty. 1723 1724 1725 1726#### \`userconfig\` 1727 1728* Default: "~/.npmrc" 1729* Type: Path 1730 1731The location of user-level configuration settings. 1732 1733This may be overridden by the \`npm_config_userconfig\` environment variable 1734or the \`--userconfig\` command line option, but may _not_ be overridden by 1735settings in the \`globalconfig\` file. 1736 1737 1738 1739#### \`version\` 1740 1741* Default: false 1742* Type: Boolean 1743 1744If true, output the npm version and exit successfully. 1745 1746Only relevant when specified explicitly on the command line. 1747 1748 1749 1750#### \`versions\` 1751 1752* Default: false 1753* Type: Boolean 1754 1755If true, output the npm version as well as node's \`process.versions\` map and 1756the version in the current working directory's \`package.json\` file if one 1757exists, and exit successfully. 1758 1759Only relevant when specified explicitly on the command line. 1760 1761 1762 1763#### \`viewer\` 1764 1765* Default: "man" on Posix, "browser" on Windows 1766* Type: String 1767 1768The program to use to view help content. 1769 1770Set to \`"browser"\` to view html help content in the default web browser. 1771 1772 1773 1774#### \`which\` 1775 1776* Default: null 1777* Type: null or Number 1778 1779If there are multiple funding sources, which 1-indexed source URL to open. 1780 1781 1782 1783#### \`workspace\` 1784 1785* Default: 1786* Type: String (can be set multiple times) 1787 1788Enable running a command in the context of the configured workspaces of the 1789current project while filtering by running only the workspaces defined by 1790this configuration option. 1791 1792Valid values for the \`workspace\` config are either: 1793 1794* Workspace names 1795* Path to a workspace directory 1796* Path to a parent workspace directory (will result in selecting all 1797 workspaces within that folder) 1798 1799When set for the \`npm init\` command, this may be set to the folder of a 1800workspace which does not yet exist, to create the folder and set it up as a 1801brand new workspace within the project. 1802 1803This value is not exported to the environment for child processes. 1804 1805#### \`workspaces\` 1806 1807* Default: null 1808* Type: null or Boolean 1809 1810Set to true to run the command in the context of **all** configured 1811workspaces. 1812 1813Explicitly setting this to false will cause commands like \`install\` to 1814ignore workspaces altogether. When not set explicitly: 1815 1816- Commands that operate on the \`node_modules\` tree (install, update, etc.) 1817will link workspaces into the \`node_modules\` folder. - Commands that do 1818other things (test, exec, publish, etc.) will operate on the root project, 1819_unless_ one or more workspaces are specified in the \`workspace\` config. 1820 1821This value is not exported to the environment for child processes. 1822 1823#### \`workspaces-update\` 1824 1825* Default: true 1826* Type: Boolean 1827 1828If set to true, the npm cli will run an update after operations that may 1829possibly change the workspaces installed to the \`node_modules\` folder. 1830 1831 1832 1833#### \`yes\` 1834 1835* Default: null 1836* Type: null or Boolean 1837 1838Automatically answer "yes" to any prompts that npm might print on the 1839command line. 1840 1841 1842 1843#### \`also\` 1844 1845* Default: null 1846* Type: null, "dev", or "development" 1847* DEPRECATED: Please use --include=dev instead. 1848 1849When set to \`dev\` or \`development\`, this is an alias for \`--include=dev\`. 1850 1851 1852 1853#### \`cache-max\` 1854 1855* Default: Infinity 1856* Type: Number 1857* DEPRECATED: This option has been deprecated in favor of \`--prefer-online\` 1858 1859\`--cache-max=0\` is an alias for \`--prefer-online\` 1860 1861 1862 1863#### \`cache-min\` 1864 1865* Default: 0 1866* Type: Number 1867* DEPRECATED: This option has been deprecated in favor of \`--prefer-offline\`. 1868 1869\`--cache-min=9999 (or bigger)\` is an alias for \`--prefer-offline\`. 1870 1871 1872 1873#### \`cert\` 1874 1875* Default: null 1876* Type: null or String 1877* DEPRECATED: \`key\` and \`cert\` are no longer used for most registry 1878 operations. Use registry scoped \`keyfile\` and \`certfile\` instead. Example: 1879 //other-registry.tld/:keyfile=/path/to/key.pem 1880 //other-registry.tld/:certfile=/path/to/cert.crt 1881 1882A client certificate to pass when accessing the registry. Values should be 1883in PEM format (Windows calls it "Base-64 encoded X.509 (.CER)") with 1884newlines replaced by the string "\\n". For example: 1885 1886\`\`\`ini 1887cert="-----BEGIN CERTIFICATE-----\\nXXXX\\nXXXX\\n-----END CERTIFICATE-----" 1888\`\`\` 1889 1890It is _not_ the path to a certificate file, though you can set a 1891registry-scoped "certfile" path like 1892"//other-registry.tld/:certfile=/path/to/cert.pem". 1893 1894 1895 1896#### \`dev\` 1897 1898* Default: false 1899* Type: Boolean 1900* DEPRECATED: Please use --include=dev instead. 1901 1902Alias for \`--include=dev\`. 1903 1904 1905 1906#### \`global-style\` 1907 1908* Default: false 1909* Type: Boolean 1910* DEPRECATED: This option has been deprecated in favor of 1911 \`--install-strategy=shallow\` 1912 1913Only install direct dependencies in the top level \`node_modules\`, but hoist 1914on deeper dependencies. Sets \`--install-strategy=shallow\`. 1915 1916 1917 1918#### \`init.author.email\` 1919 1920* Default: "" 1921* Type: String 1922* DEPRECATED: Use \`--init-author-email\` instead. 1923 1924Alias for \`--init-author-email\` 1925 1926 1927 1928#### \`init.author.name\` 1929 1930* Default: "" 1931* Type: String 1932* DEPRECATED: Use \`--init-author-name\` instead. 1933 1934Alias for \`--init-author-name\` 1935 1936 1937 1938#### \`init.author.url\` 1939 1940* Default: "" 1941* Type: "" or URL 1942* DEPRECATED: Use \`--init-author-url\` instead. 1943 1944Alias for \`--init-author-url\` 1945 1946 1947 1948#### \`init.license\` 1949 1950* Default: "ISC" 1951* Type: String 1952* DEPRECATED: Use \`--init-license\` instead. 1953 1954Alias for \`--init-license\` 1955 1956 1957 1958#### \`init.module\` 1959 1960* Default: "~/.npm-init.js" 1961* Type: Path 1962* DEPRECATED: Use \`--init-module\` instead. 1963 1964Alias for \`--init-module\` 1965 1966 1967 1968#### \`init.version\` 1969 1970* Default: "1.0.0" 1971* Type: SemVer string 1972* DEPRECATED: Use \`--init-version\` instead. 1973 1974Alias for \`--init-version\` 1975 1976 1977 1978#### \`key\` 1979 1980* Default: null 1981* Type: null or String 1982* DEPRECATED: \`key\` and \`cert\` are no longer used for most registry 1983 operations. Use registry scoped \`keyfile\` and \`certfile\` instead. Example: 1984 //other-registry.tld/:keyfile=/path/to/key.pem 1985 //other-registry.tld/:certfile=/path/to/cert.crt 1986 1987A client key to pass when accessing the registry. Values should be in PEM 1988format with newlines replaced by the string "\\n". For example: 1989 1990\`\`\`ini 1991key="-----BEGIN PRIVATE KEY-----\\nXXXX\\nXXXX\\n-----END PRIVATE KEY-----" 1992\`\`\` 1993 1994It is _not_ the path to a key file, though you can set a registry-scoped 1995"keyfile" path like "//other-registry.tld/:keyfile=/path/to/key.pem". 1996 1997 1998 1999#### \`legacy-bundling\` 2000 2001* Default: false 2002* Type: Boolean 2003* DEPRECATED: This option has been deprecated in favor of 2004 \`--install-strategy=nested\` 2005 2006Instead of hoisting package installs in \`node_modules\`, install packages in 2007the same manner that they are depended on. This may cause very deep 2008directory structures and duplicate package installs as there is no 2009de-duplicating. Sets \`--install-strategy=nested\`. 2010 2011 2012 2013#### \`only\` 2014 2015* Default: null 2016* Type: null, "prod", or "production" 2017* DEPRECATED: Use \`--omit=dev\` to omit dev dependencies from the install. 2018 2019When set to \`prod\` or \`production\`, this is an alias for \`--omit=dev\`. 2020 2021 2022 2023#### \`optional\` 2024 2025* Default: null 2026* Type: null or Boolean 2027* DEPRECATED: Use \`--omit=optional\` to exclude optional dependencies, or 2028 \`--include=optional\` to include them. 2029 2030Default value does install optional deps unless otherwise omitted. 2031 2032Alias for --include=optional or --omit=optional 2033 2034 2035 2036#### \`production\` 2037 2038* Default: null 2039* Type: null or Boolean 2040* DEPRECATED: Use \`--omit=dev\` instead. 2041 2042Alias for \`--omit=dev\` 2043 2044 2045 2046#### \`shrinkwrap\` 2047 2048* Default: true 2049* Type: Boolean 2050* DEPRECATED: Use the --package-lock setting instead. 2051 2052Alias for --package-lock 2053 2054 2055` 2056 2057exports[`test/lib/docs.js TAP config > all keys 1`] = ` 2058Array [ 2059 "_auth", 2060 "access", 2061 "all", 2062 "allow-same-version", 2063 "also", 2064 "audit", 2065 "audit-level", 2066 "auth-type", 2067 "before", 2068 "bin-links", 2069 "browser", 2070 "ca", 2071 "cache", 2072 "cache-max", 2073 "cache-min", 2074 "cafile", 2075 "call", 2076 "cert", 2077 "cidr", 2078 "color", 2079 "commit-hooks", 2080 "cpu", 2081 "os", 2082 "libc", 2083 "depth", 2084 "description", 2085 "dev", 2086 "diff", 2087 "diff-ignore-all-space", 2088 "diff-name-only", 2089 "diff-no-prefix", 2090 "diff-dst-prefix", 2091 "diff-src-prefix", 2092 "diff-text", 2093 "diff-unified", 2094 "dry-run", 2095 "editor", 2096 "engine-strict", 2097 "expect-results", 2098 "expect-result-count", 2099 "fetch-retries", 2100 "fetch-retry-factor", 2101 "fetch-retry-maxtimeout", 2102 "fetch-retry-mintimeout", 2103 "fetch-timeout", 2104 "force", 2105 "foreground-scripts", 2106 "format-package-lock", 2107 "fund", 2108 "git", 2109 "git-tag-version", 2110 "global", 2111 "globalconfig", 2112 "global-style", 2113 "heading", 2114 "https-proxy", 2115 "if-present", 2116 "ignore-scripts", 2117 "include", 2118 "include-staged", 2119 "include-workspace-root", 2120 "init-author-email", 2121 "init-author-name", 2122 "init-author-url", 2123 "init-license", 2124 "init-module", 2125 "init-version", 2126 "init.author.email", 2127 "init.author.name", 2128 "init.author.url", 2129 "init.license", 2130 "init.module", 2131 "init.version", 2132 "install-links", 2133 "install-strategy", 2134 "json", 2135 "key", 2136 "legacy-bundling", 2137 "legacy-peer-deps", 2138 "link", 2139 "local-address", 2140 "sbom-format", 2141 "sbom-type", 2142 "location", 2143 "lockfile-version", 2144 "loglevel", 2145 "logs-dir", 2146 "logs-max", 2147 "long", 2148 "maxsockets", 2149 "message", 2150 "node-options", 2151 "noproxy", 2152 "offline", 2153 "omit", 2154 "omit-lockfile-registry-resolved", 2155 "only", 2156 "optional", 2157 "otp", 2158 "package", 2159 "package-lock", 2160 "package-lock-only", 2161 "pack-destination", 2162 "parseable", 2163 "prefer-dedupe", 2164 "prefer-offline", 2165 "prefer-online", 2166 "prefix", 2167 "preid", 2168 "production", 2169 "progress", 2170 "provenance", 2171 "provenance-file", 2172 "proxy", 2173 "read-only", 2174 "rebuild-bundle", 2175 "registry", 2176 "replace-registry-host", 2177 "save", 2178 "save-bundle", 2179 "save-dev", 2180 "save-exact", 2181 "save-optional", 2182 "save-peer", 2183 "save-prefix", 2184 "save-prod", 2185 "scope", 2186 "script-shell", 2187 "searchexclude", 2188 "searchlimit", 2189 "searchopts", 2190 "searchstaleness", 2191 "shell", 2192 "shrinkwrap", 2193 "sign-git-commit", 2194 "sign-git-tag", 2195 "strict-peer-deps", 2196 "strict-ssl", 2197 "tag", 2198 "tag-version-prefix", 2199 "timing", 2200 "umask", 2201 "unicode", 2202 "update-notifier", 2203 "usage", 2204 "user-agent", 2205 "userconfig", 2206 "version", 2207 "versions", 2208 "viewer", 2209 "which", 2210 "workspace", 2211 "workspaces", 2212 "workspaces-update", 2213 "yes", 2214] 2215` 2216 2217exports[`test/lib/docs.js TAP config > keys that are flattened 1`] = ` 2218Array [ 2219 "_auth", 2220 "access", 2221 "all", 2222 "allow-same-version", 2223 "also", 2224 "audit", 2225 "audit-level", 2226 "auth-type", 2227 "before", 2228 "bin-links", 2229 "browser", 2230 "ca", 2231 "cache", 2232 "cache-max", 2233 "cache-min", 2234 "cafile", 2235 "call", 2236 "cert", 2237 "cidr", 2238 "color", 2239 "commit-hooks", 2240 "cpu", 2241 "os", 2242 "libc", 2243 "depth", 2244 "description", 2245 "dev", 2246 "diff", 2247 "diff-ignore-all-space", 2248 "diff-name-only", 2249 "diff-no-prefix", 2250 "diff-dst-prefix", 2251 "diff-src-prefix", 2252 "diff-text", 2253 "diff-unified", 2254 "dry-run", 2255 "editor", 2256 "engine-strict", 2257 "fetch-retries", 2258 "fetch-retry-factor", 2259 "fetch-retry-maxtimeout", 2260 "fetch-retry-mintimeout", 2261 "fetch-timeout", 2262 "force", 2263 "foreground-scripts", 2264 "format-package-lock", 2265 "fund", 2266 "git", 2267 "git-tag-version", 2268 "global", 2269 "globalconfig", 2270 "global-style", 2271 "heading", 2272 "https-proxy", 2273 "if-present", 2274 "ignore-scripts", 2275 "include", 2276 "include-staged", 2277 "include-workspace-root", 2278 "install-links", 2279 "install-strategy", 2280 "json", 2281 "key", 2282 "legacy-bundling", 2283 "legacy-peer-deps", 2284 "local-address", 2285 "sbom-format", 2286 "sbom-type", 2287 "location", 2288 "lockfile-version", 2289 "loglevel", 2290 "maxsockets", 2291 "message", 2292 "noproxy", 2293 "offline", 2294 "omit", 2295 "omit-lockfile-registry-resolved", 2296 "only", 2297 "optional", 2298 "otp", 2299 "package", 2300 "package-lock", 2301 "package-lock-only", 2302 "pack-destination", 2303 "parseable", 2304 "prefer-dedupe", 2305 "prefer-offline", 2306 "prefer-online", 2307 "preid", 2308 "production", 2309 "progress", 2310 "provenance", 2311 "provenance-file", 2312 "proxy", 2313 "read-only", 2314 "rebuild-bundle", 2315 "registry", 2316 "replace-registry-host", 2317 "save", 2318 "save-bundle", 2319 "save-dev", 2320 "save-exact", 2321 "save-optional", 2322 "save-peer", 2323 "save-prefix", 2324 "save-prod", 2325 "scope", 2326 "script-shell", 2327 "searchexclude", 2328 "searchlimit", 2329 "searchopts", 2330 "searchstaleness", 2331 "shell", 2332 "shrinkwrap", 2333 "sign-git-commit", 2334 "sign-git-tag", 2335 "strict-peer-deps", 2336 "strict-ssl", 2337 "tag", 2338 "tag-version-prefix", 2339 "umask", 2340 "unicode", 2341 "user-agent", 2342 "workspace", 2343 "workspaces", 2344 "workspaces-update", 2345] 2346` 2347 2348exports[`test/lib/docs.js TAP config > keys that are not flattened 1`] = ` 2349Array [ 2350 "expect-results", 2351 "expect-result-count", 2352 "init-author-email", 2353 "init-author-name", 2354 "init-author-url", 2355 "init-license", 2356 "init-module", 2357 "init-version", 2358 "init.author.email", 2359 "init.author.name", 2360 "init.author.url", 2361 "init.license", 2362 "init.module", 2363 "init.version", 2364 "link", 2365 "logs-dir", 2366 "logs-max", 2367 "long", 2368 "node-options", 2369 "prefix", 2370 "timing", 2371 "update-notifier", 2372 "usage", 2373 "userconfig", 2374 "version", 2375 "versions", 2376 "viewer", 2377 "which", 2378 "yes", 2379] 2380` 2381 2382exports[`test/lib/docs.js TAP flat options > full flat options object 1`] = ` 2383Object { 2384 "_auth": null, 2385 "access": null, 2386 "all": false, 2387 "allowSameVersion": false, 2388 "audit": true, 2389 "auditLevel": null, 2390 "authType": "web", 2391 "before": null, 2392 "binLinks": true, 2393 "browser": null, 2394 "ca": null, 2395 "cache": "{CWD}/cache/_cacache", 2396 "call": "", 2397 "cert": null, 2398 "cidr": null, 2399 "color": false, 2400 "commitHooks": true, 2401 "cpu": null, 2402 "defaultTag": "latest", 2403 "depth": null, 2404 "diff": Array [], 2405 "diffDstPrefix": "b/", 2406 "diffIgnoreAllSpace": false, 2407 "diffNameOnly": false, 2408 "diffNoPrefix": false, 2409 "diffSrcPrefix": "a/", 2410 "diffText": false, 2411 "diffUnified": 3, 2412 "dryRun": false, 2413 "editor": "{EDITOR}", 2414 "engineStrict": false, 2415 "force": false, 2416 "foregroundScripts": false, 2417 "formatPackageLock": true, 2418 "fund": true, 2419 "git": "git", 2420 "gitTagVersion": true, 2421 "global": false, 2422 "globalconfig": "{CWD}/global/etc/npmrc", 2423 "heading": "npm", 2424 "httpsProxy": null, 2425 "ifPresent": false, 2426 "ignoreScripts": false, 2427 "includeStaged": false, 2428 "includeWorkspaceRoot": false, 2429 "installLinks": false, 2430 "installStrategy": "hoisted", 2431 "json": false, 2432 "key": null, 2433 "legacyPeerDeps": false, 2434 "libc": null, 2435 "localAddress": null, 2436 "location": "user", 2437 "lockfileVersion": null, 2438 "logColor": false, 2439 "maxSockets": 15, 2440 "message": "%s", 2441 "nodeBin": "{NODE}", 2442 "nodeVersion": "2.2.2", 2443 "noProxy": "", 2444 "npmBin": "{CWD}/other/bin/npm-cli.js", 2445 "npmCommand": "version", 2446 "npmVersion": "3.3.3", 2447 "npxCache": "{CWD}/cache/_npx", 2448 "offline": false, 2449 "omit": Array [], 2450 "omitLockfileRegistryResolved": false, 2451 "os": null, 2452 "otp": null, 2453 "package": Array [], 2454 "packageLock": true, 2455 "packageLockOnly": false, 2456 "packDestination": ".", 2457 "parseable": false, 2458 "preferDedupe": false, 2459 "preferOffline": false, 2460 "preferOnline": false, 2461 "preid": "", 2462 "progress": false, 2463 "projectScope": "", 2464 "provenance": false, 2465 "provenanceFile": null, 2466 "proxy": null, 2467 "readOnly": false, 2468 "rebuildBundle": true, 2469 "registry": "https://registry.npmjs.org/", 2470 "replaceRegistryHost": "npmjs", 2471 "retry": Object { 2472 "factor": 10, 2473 "maxTimeout": 60000, 2474 "minTimeout": 10000, 2475 "retries": 0, 2476 }, 2477 "save": true, 2478 "saveBundle": false, 2479 "savePrefix": "^", 2480 "sbomFormat": null, 2481 "sbomType": "library", 2482 "scope": "", 2483 "scriptShell": undefined, 2484 "search": Object { 2485 "description": true, 2486 "exclude": "", 2487 "limit": 20, 2488 "opts": Null Object {}, 2489 "staleness": 900, 2490 }, 2491 "shell": "{SHELL}", 2492 "signGitCommit": false, 2493 "signGitTag": false, 2494 "silent": false, 2495 "strictPeerDeps": false, 2496 "strictSSL": true, 2497 "tagVersionPrefix": "v", 2498 "timeout": 300000, 2499 "tufCache": "{CWD}/cache/_tuf", 2500 "umask": 0, 2501 "unicode": false, 2502 "userAgent": "npm/1.1.1 node/2.2.2 {PLATFORM} {ARCH} workspaces/false ci/{ci}", 2503 "workspacesEnabled": true, 2504 "workspacesUpdate": true, 2505} 2506` 2507 2508exports[`test/lib/docs.js TAP shorthands > docs 1`] = ` 2509* \`-a\`: \`--all\` 2510* \`--enjoy-by\`: \`--before\` 2511* \`-c\`: \`--call\` 2512* \`--desc\`: \`--description\` 2513* \`-f\`: \`--force\` 2514* \`-g\`: \`--global\` 2515* \`--iwr\`: \`--include-workspace-root\` 2516* \`-L\`: \`--location\` 2517* \`-d\`: \`--loglevel info\` 2518* \`-s\`: \`--loglevel silent\` 2519* \`--silent\`: \`--loglevel silent\` 2520* \`--ddd\`: \`--loglevel silly\` 2521* \`--dd\`: \`--loglevel verbose\` 2522* \`--verbose\`: \`--loglevel verbose\` 2523* \`-q\`: \`--loglevel warn\` 2524* \`--quiet\`: \`--loglevel warn\` 2525* \`-l\`: \`--long\` 2526* \`-m\`: \`--message\` 2527* \`--local\`: \`--no-global\` 2528* \`-n\`: \`--no-yes\` 2529* \`--no\`: \`--no-yes\` 2530* \`-p\`: \`--parseable\` 2531* \`--porcelain\`: \`--parseable\` 2532* \`-C\`: \`--prefix\` 2533* \`--readonly\`: \`--read-only\` 2534* \`--reg\`: \`--registry\` 2535* \`-S\`: \`--save\` 2536* \`-B\`: \`--save-bundle\` 2537* \`-D\`: \`--save-dev\` 2538* \`-E\`: \`--save-exact\` 2539* \`-O\`: \`--save-optional\` 2540* \`-P\`: \`--save-prod\` 2541* \`-?\`: \`--usage\` 2542* \`-h\`: \`--usage\` 2543* \`-H\`: \`--usage\` 2544* \`--help\`: \`--usage\` 2545* \`-v\`: \`--version\` 2546* \`-w\`: \`--workspace\` 2547* \`--ws\`: \`--workspaces\` 2548* \`-y\`: \`--yes\` 2549` 2550 2551exports[`test/lib/docs.js TAP usage access > must match snapshot 1`] = ` 2552Set access level on published packages 2553 2554Usage: 2555npm access list packages [<user>|<scope>|<scope:team> [<package>] 2556npm access list collaborators [<package> [<user>]] 2557npm access get status [<package>] 2558npm access set status=public|private [<package>] 2559npm access set mfa=none|publish|automation [<package>] 2560npm access grant <read-only|read-write> <scope:team> [<package>] 2561npm access revoke <scope:team> [<package>] 2562 2563Options: 2564[--json] [--otp <otp>] [--registry <registry>] 2565 2566Run "npm help access" for more info 2567 2568\`\`\`bash 2569npm access list packages [<user>|<scope>|<scope:team> [<package>] 2570npm access list collaborators [<package> [<user>]] 2571npm access get status [<package>] 2572npm access set status=public|private [<package>] 2573npm access set mfa=none|publish|automation [<package>] 2574npm access grant <read-only|read-write> <scope:team> [<package>] 2575npm access revoke <scope:team> [<package>] 2576\`\`\` 2577 2578Note: This command is unaware of workspaces. 2579 2580#### \`json\` 2581#### \`otp\` 2582#### \`registry\` 2583` 2584 2585exports[`test/lib/docs.js TAP usage adduser > must match snapshot 1`] = ` 2586Add a registry user account 2587 2588Usage: 2589npm adduser 2590 2591Options: 2592[--registry <registry>] [--scope <@scope>] [--auth-type <legacy|web>] 2593 2594alias: add-user 2595 2596Run "npm help adduser" for more info 2597 2598\`\`\`bash 2599npm adduser 2600 2601alias: add-user 2602\`\`\` 2603 2604Note: This command is unaware of workspaces. 2605 2606#### \`registry\` 2607#### \`scope\` 2608#### \`auth-type\` 2609` 2610 2611exports[`test/lib/docs.js TAP usage audit > must match snapshot 1`] = ` 2612Run a security audit 2613 2614Usage: 2615npm audit [fix|signatures] 2616 2617Options: 2618[--audit-level <info|low|moderate|high|critical|none>] [--dry-run] [-f|--force] 2619[--json] [--package-lock-only] [--no-package-lock] 2620[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] 2621[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]] 2622[--foreground-scripts] [--ignore-scripts] 2623[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 2624[-ws|--workspaces] [--include-workspace-root] [--install-links] 2625 2626Run "npm help audit" for more info 2627 2628\`\`\`bash 2629npm audit [fix|signatures] 2630\`\`\` 2631 2632#### \`audit-level\` 2633#### \`dry-run\` 2634#### \`force\` 2635#### \`json\` 2636#### \`package-lock-only\` 2637#### \`package-lock\` 2638#### \`omit\` 2639#### \`include\` 2640#### \`foreground-scripts\` 2641#### \`ignore-scripts\` 2642#### \`workspace\` 2643#### \`workspaces\` 2644#### \`include-workspace-root\` 2645#### \`install-links\` 2646` 2647 2648exports[`test/lib/docs.js TAP usage bugs > must match snapshot 1`] = ` 2649Report bugs for a package in a web browser 2650 2651Usage: 2652npm bugs [<pkgname> [<pkgname> ...]] 2653 2654Options: 2655[--no-browser|--browser <browser>] [--registry <registry>] 2656[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 2657[-ws|--workspaces] [--include-workspace-root] 2658 2659alias: issues 2660 2661Run "npm help bugs" for more info 2662 2663\`\`\`bash 2664npm bugs [<pkgname> [<pkgname> ...]] 2665 2666alias: issues 2667\`\`\` 2668 2669#### \`browser\` 2670#### \`registry\` 2671#### \`workspace\` 2672#### \`workspaces\` 2673#### \`include-workspace-root\` 2674` 2675 2676exports[`test/lib/docs.js TAP usage cache > must match snapshot 1`] = ` 2677Manipulates packages cache 2678 2679Usage: 2680npm cache add <package-spec> 2681npm cache clean [<key>] 2682npm cache ls [<name>@<version>] 2683npm cache verify 2684 2685Options: 2686[--cache <cache>] 2687 2688Run "npm help cache" for more info 2689 2690\`\`\`bash 2691npm cache add <package-spec> 2692npm cache clean [<key>] 2693npm cache ls [<name>@<version>] 2694npm cache verify 2695\`\`\` 2696 2697Note: This command is unaware of workspaces. 2698 2699#### \`cache\` 2700` 2701 2702exports[`test/lib/docs.js TAP usage ci > must match snapshot 1`] = ` 2703Clean install a project 2704 2705Usage: 2706npm ci 2707 2708Options: 2709[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling] 2710[--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] 2711[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]] 2712[--strict-peer-deps] [--foreground-scripts] [--ignore-scripts] [--no-audit] 2713[--no-bin-links] [--no-fund] [--dry-run] 2714[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 2715[-ws|--workspaces] [--include-workspace-root] [--install-links] 2716 2717aliases: clean-install, ic, install-clean, isntall-clean 2718 2719Run "npm help ci" for more info 2720 2721\`\`\`bash 2722npm ci 2723 2724aliases: clean-install, ic, install-clean, isntall-clean 2725\`\`\` 2726 2727#### \`install-strategy\` 2728#### \`legacy-bundling\` 2729#### \`global-style\` 2730#### \`omit\` 2731#### \`include\` 2732#### \`strict-peer-deps\` 2733#### \`foreground-scripts\` 2734#### \`ignore-scripts\` 2735#### \`audit\` 2736#### \`bin-links\` 2737#### \`fund\` 2738#### \`dry-run\` 2739#### \`workspace\` 2740#### \`workspaces\` 2741#### \`include-workspace-root\` 2742#### \`install-links\` 2743` 2744 2745exports[`test/lib/docs.js TAP usage completion > must match snapshot 1`] = ` 2746Tab Completion for npm 2747 2748Usage: 2749npm completion 2750 2751Run "npm help completion" for more info 2752 2753\`\`\`bash 2754npm completion 2755\`\`\` 2756 2757Note: This command is unaware of workspaces. 2758 2759NO PARAMS 2760` 2761 2762exports[`test/lib/docs.js TAP usage config > must match snapshot 1`] = ` 2763Manage the npm configuration files 2764 2765Usage: 2766npm config set <key>=<value> [<key>=<value> ...] 2767npm config get [<key> [<key> ...]] 2768npm config delete <key> [<key> ...] 2769npm config list [--json] 2770npm config edit 2771npm config fix 2772 2773Options: 2774[--json] [-g|--global] [--editor <editor>] [-L|--location <global|user|project>] 2775[-l|--long] 2776 2777alias: c 2778 2779Run "npm help config" for more info 2780 2781\`\`\`bash 2782npm config set <key>=<value> [<key>=<value> ...] 2783npm config get [<key> [<key> ...]] 2784npm config delete <key> [<key> ...] 2785npm config list [--json] 2786npm config edit 2787npm config fix 2788 2789alias: c 2790\`\`\` 2791 2792Note: This command is unaware of workspaces. 2793 2794#### \`json\` 2795#### \`global\` 2796#### \`editor\` 2797#### \`location\` 2798#### \`long\` 2799` 2800 2801exports[`test/lib/docs.js TAP usage dedupe > must match snapshot 1`] = ` 2802Reduce duplication in the package tree 2803 2804Usage: 2805npm dedupe 2806 2807Options: 2808[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling] 2809[--global-style] [--strict-peer-deps] [--no-package-lock] 2810[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] 2811[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]] 2812[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run] 2813[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 2814[-ws|--workspaces] [--include-workspace-root] [--install-links] 2815 2816alias: ddp 2817 2818Run "npm help dedupe" for more info 2819 2820\`\`\`bash 2821npm dedupe 2822 2823alias: ddp 2824\`\`\` 2825 2826#### \`install-strategy\` 2827#### \`legacy-bundling\` 2828#### \`global-style\` 2829#### \`strict-peer-deps\` 2830#### \`package-lock\` 2831#### \`omit\` 2832#### \`include\` 2833#### \`ignore-scripts\` 2834#### \`audit\` 2835#### \`bin-links\` 2836#### \`fund\` 2837#### \`dry-run\` 2838#### \`workspace\` 2839#### \`workspaces\` 2840#### \`include-workspace-root\` 2841#### \`install-links\` 2842` 2843 2844exports[`test/lib/docs.js TAP usage deprecate > must match snapshot 1`] = ` 2845Deprecate a version of a package 2846 2847Usage: 2848npm deprecate <package-spec> <message> 2849 2850Options: 2851[--registry <registry>] [--otp <otp>] 2852 2853Run "npm help deprecate" for more info 2854 2855\`\`\`bash 2856npm deprecate <package-spec> <message> 2857\`\`\` 2858 2859Note: This command is unaware of workspaces. 2860 2861#### \`registry\` 2862#### \`otp\` 2863` 2864 2865exports[`test/lib/docs.js TAP usage diff > must match snapshot 1`] = ` 2866The registry diff command 2867 2868Usage: 2869npm diff [...<paths>] 2870 2871Options: 2872[--diff <package-spec> [--diff <package-spec> ...]] [--diff-name-only] 2873[--diff-unified <number>] [--diff-ignore-all-space] [--diff-no-prefix] 2874[--diff-src-prefix <path>] [--diff-dst-prefix <path>] [--diff-text] [-g|--global] 2875[--tag <tag>] 2876[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 2877[-ws|--workspaces] [--include-workspace-root] 2878 2879Run "npm help diff" for more info 2880 2881\`\`\`bash 2882npm diff [...<paths>] 2883\`\`\` 2884 2885#### \`diff\` 2886#### \`diff-name-only\` 2887#### \`diff-unified\` 2888#### \`diff-ignore-all-space\` 2889#### \`diff-no-prefix\` 2890#### \`diff-src-prefix\` 2891#### \`diff-dst-prefix\` 2892#### \`diff-text\` 2893#### \`global\` 2894#### \`tag\` 2895#### \`workspace\` 2896#### \`workspaces\` 2897#### \`include-workspace-root\` 2898` 2899 2900exports[`test/lib/docs.js TAP usage dist-tag > must match snapshot 1`] = ` 2901Modify package distribution tags 2902 2903Usage: 2904npm dist-tag add <package-spec (with version)> [<tag>] 2905npm dist-tag rm <package-spec> <tag> 2906npm dist-tag ls [<package-spec>] 2907 2908Options: 2909[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 2910[-ws|--workspaces] [--include-workspace-root] 2911 2912alias: dist-tags 2913 2914Run "npm help dist-tag" for more info 2915 2916\`\`\`bash 2917npm dist-tag add <package-spec (with version)> [<tag>] 2918npm dist-tag rm <package-spec> <tag> 2919npm dist-tag ls [<package-spec>] 2920 2921alias: dist-tags 2922\`\`\` 2923 2924#### \`workspace\` 2925#### \`workspaces\` 2926#### \`include-workspace-root\` 2927` 2928 2929exports[`test/lib/docs.js TAP usage docs > must match snapshot 1`] = ` 2930Open documentation for a package in a web browser 2931 2932Usage: 2933npm docs [<pkgname> [<pkgname> ...]] 2934 2935Options: 2936[--no-browser|--browser <browser>] [--registry <registry>] 2937[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 2938[-ws|--workspaces] [--include-workspace-root] 2939 2940alias: home 2941 2942Run "npm help docs" for more info 2943 2944\`\`\`bash 2945npm docs [<pkgname> [<pkgname> ...]] 2946 2947alias: home 2948\`\`\` 2949 2950#### \`browser\` 2951#### \`registry\` 2952#### \`workspace\` 2953#### \`workspaces\` 2954#### \`include-workspace-root\` 2955` 2956 2957exports[`test/lib/docs.js TAP usage doctor > must match snapshot 1`] = ` 2958Check the health of your npm environment 2959 2960Usage: 2961npm doctor [ping] [registry] [versions] [environment] [permissions] [cache] 2962 2963Options: 2964[--registry <registry>] 2965 2966Run "npm help doctor" for more info 2967 2968\`\`\`bash 2969npm doctor [ping] [registry] [versions] [environment] [permissions] [cache] 2970\`\`\` 2971 2972Note: This command is unaware of workspaces. 2973 2974#### \`registry\` 2975` 2976 2977exports[`test/lib/docs.js TAP usage edit > must match snapshot 1`] = ` 2978Edit an installed package 2979 2980Usage: 2981npm edit <pkg>[/<subpkg>...] 2982 2983Options: 2984[--editor <editor>] 2985 2986Run "npm help edit" for more info 2987 2988\`\`\`bash 2989npm edit <pkg>[/<subpkg>...] 2990\`\`\` 2991 2992Note: This command is unaware of workspaces. 2993 2994#### \`editor\` 2995` 2996 2997exports[`test/lib/docs.js TAP usage exec > must match snapshot 1`] = ` 2998Run a command from a local or remote npm package 2999 3000Usage: 3001npm exec -- <pkg>[@<version>] [args...] 3002npm exec --package=<pkg>[@<version>] -- <cmd> [args...] 3003npm exec -c '<cmd> [args...]' 3004npm exec --package=foo -c '<cmd> [args...]' 3005 3006Options: 3007[--package <package-spec> [--package <package-spec> ...]] [-c|--call <call>] 3008[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3009[-ws|--workspaces] [--include-workspace-root] 3010 3011alias: x 3012 3013Run "npm help exec" for more info 3014 3015\`\`\`bash 3016npm exec -- <pkg>[@<version>] [args...] 3017npm exec --package=<pkg>[@<version>] -- <cmd> [args...] 3018npm exec -c '<cmd> [args...]' 3019npm exec --package=foo -c '<cmd> [args...]' 3020 3021alias: x 3022\`\`\` 3023 3024#### \`package\` 3025#### \`call\` 3026#### \`workspace\` 3027#### \`workspaces\` 3028#### \`include-workspace-root\` 3029` 3030 3031exports[`test/lib/docs.js TAP usage explain > must match snapshot 1`] = ` 3032Explain installed packages 3033 3034Usage: 3035npm explain <package-spec> 3036 3037Options: 3038[--json] [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3039 3040alias: why 3041 3042Run "npm help explain" for more info 3043 3044\`\`\`bash 3045npm explain <package-spec> 3046 3047alias: why 3048\`\`\` 3049 3050#### \`json\` 3051#### \`workspace\` 3052` 3053 3054exports[`test/lib/docs.js TAP usage explore > must match snapshot 1`] = ` 3055Browse an installed package 3056 3057Usage: 3058npm explore <pkg> [ -- <command>] 3059 3060Options: 3061[--shell <shell>] 3062 3063Run "npm help explore" for more info 3064 3065\`\`\`bash 3066npm explore <pkg> [ -- <command>] 3067\`\`\` 3068 3069Note: This command is unaware of workspaces. 3070 3071#### \`shell\` 3072` 3073 3074exports[`test/lib/docs.js TAP usage find-dupes > must match snapshot 1`] = ` 3075Find duplication in the package tree 3076 3077Usage: 3078npm find-dupes 3079 3080Options: 3081[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling] 3082[--global-style] [--strict-peer-deps] [--no-package-lock] 3083[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] 3084[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]] 3085[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] 3086[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3087[-ws|--workspaces] [--include-workspace-root] [--install-links] 3088 3089Run "npm help find-dupes" for more info 3090 3091\`\`\`bash 3092npm find-dupes 3093\`\`\` 3094 3095#### \`install-strategy\` 3096#### \`legacy-bundling\` 3097#### \`global-style\` 3098#### \`strict-peer-deps\` 3099#### \`package-lock\` 3100#### \`omit\` 3101#### \`include\` 3102#### \`ignore-scripts\` 3103#### \`audit\` 3104#### \`bin-links\` 3105#### \`fund\` 3106#### \`workspace\` 3107#### \`workspaces\` 3108#### \`include-workspace-root\` 3109#### \`install-links\` 3110` 3111 3112exports[`test/lib/docs.js TAP usage fund > must match snapshot 1`] = ` 3113Retrieve funding information 3114 3115Usage: 3116npm fund [<package-spec>] 3117 3118Options: 3119[--json] [--no-browser|--browser <browser>] [--unicode] 3120[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3121[--which <fundingSourceNumber>] 3122 3123Run "npm help fund" for more info 3124 3125\`\`\`bash 3126npm fund [<package-spec>] 3127\`\`\` 3128 3129#### \`json\` 3130#### \`browser\` 3131#### \`unicode\` 3132#### \`workspace\` 3133#### \`which\` 3134` 3135 3136exports[`test/lib/docs.js TAP usage get > must match snapshot 1`] = ` 3137Get a value from the npm configuration 3138 3139Usage: 3140npm get [<key> ...] (See \`npm config\`) 3141 3142Options: 3143[-l|--long] 3144 3145Run "npm help get" for more info 3146 3147\`\`\`bash 3148npm get [<key> ...] (See \`npm config\`) 3149\`\`\` 3150 3151Note: This command is unaware of workspaces. 3152 3153#### \`long\` 3154` 3155 3156exports[`test/lib/docs.js TAP usage help > must match snapshot 1`] = ` 3157Get help on npm 3158 3159Usage: 3160npm help <term> [<terms..>] 3161 3162Options: 3163[--viewer <viewer>] 3164 3165alias: hlep 3166 3167Run "npm help help" for more info 3168 3169\`\`\`bash 3170npm help <term> [<terms..>] 3171 3172alias: hlep 3173\`\`\` 3174 3175Note: This command is unaware of workspaces. 3176 3177#### \`viewer\` 3178` 3179 3180exports[`test/lib/docs.js TAP usage help-search > must match snapshot 1`] = ` 3181Search npm help documentation 3182 3183Usage: 3184npm help-search <text> 3185 3186Options: 3187[-l|--long] 3188 3189Run "npm help help-search" for more info 3190 3191\`\`\`bash 3192npm help-search <text> 3193\`\`\` 3194 3195Note: This command is unaware of workspaces. 3196 3197#### \`long\` 3198` 3199 3200exports[`test/lib/docs.js TAP usage hook > must match snapshot 1`] = ` 3201Manage registry hooks 3202 3203Usage: 3204npm hook add <pkg> <url> <secret> [--type=<type>] 3205npm hook ls [pkg] 3206npm hook rm <id> 3207npm hook update <id> <url> <secret> 3208 3209Options: 3210[--registry <registry>] [--otp <otp>] 3211 3212Run "npm help hook" for more info 3213 3214\`\`\`bash 3215npm hook add <pkg> <url> <secret> [--type=<type>] 3216npm hook ls [pkg] 3217npm hook rm <id> 3218npm hook update <id> <url> <secret> 3219\`\`\` 3220 3221Note: This command is unaware of workspaces. 3222 3223#### \`registry\` 3224#### \`otp\` 3225` 3226 3227exports[`test/lib/docs.js TAP usage init > must match snapshot 1`] = ` 3228Create a package.json file 3229 3230Usage: 3231npm init <package-spec> (same as \`npx <package-spec>\`) 3232npm init <@scope> (same as \`npx <@scope>/create\`) 3233 3234Options: 3235[--init-author-name <name>] [--init-author-url <url>] [--init-license <license>] 3236[--init-module <module>] [--init-version <version>] [-y|--yes] [-f|--force] 3237[--scope <@scope>] 3238[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3239[-ws|--workspaces] [--no-workspaces-update] [--include-workspace-root] 3240 3241aliases: create, innit 3242 3243Run "npm help init" for more info 3244 3245\`\`\`bash 3246npm init <package-spec> (same as \`npx <package-spec>\`) 3247npm init <@scope> (same as \`npx <@scope>/create\`) 3248 3249aliases: create, innit 3250\`\`\` 3251 3252#### \`init-author-name\` 3253#### \`init-author-url\` 3254#### \`init-license\` 3255#### \`init-module\` 3256#### \`init-version\` 3257#### \`yes\` 3258#### \`force\` 3259#### \`scope\` 3260#### \`workspace\` 3261#### \`workspaces\` 3262#### \`workspaces-update\` 3263#### \`include-workspace-root\` 3264` 3265 3266exports[`test/lib/docs.js TAP usage install > must match snapshot 1`] = ` 3267Install a package 3268 3269Usage: 3270npm install [<package-spec> ...] 3271 3272Options: 3273[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle] 3274[-E|--save-exact] [-g|--global] 3275[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling] 3276[--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] 3277[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]] 3278[--strict-peer-deps] [--prefer-dedupe] [--no-package-lock] [--package-lock-only] 3279[--foreground-scripts] [--ignore-scripts] [--no-audit] [--no-bin-links] 3280[--no-fund] [--dry-run] [--cpu <cpu>] [--os <os>] [--libc <libc>] 3281[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3282[-ws|--workspaces] [--include-workspace-root] [--install-links] 3283 3284aliases: add, i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall 3285 3286Run "npm help install" for more info 3287 3288\`\`\`bash 3289npm install [<package-spec> ...] 3290 3291aliases: add, i, in, ins, inst, insta, instal, isnt, isnta, isntal, isntall 3292\`\`\` 3293 3294#### \`save\` 3295#### \`save-exact\` 3296#### \`global\` 3297#### \`install-strategy\` 3298#### \`legacy-bundling\` 3299#### \`global-style\` 3300#### \`omit\` 3301#### \`include\` 3302#### \`strict-peer-deps\` 3303#### \`prefer-dedupe\` 3304#### \`package-lock\` 3305#### \`package-lock-only\` 3306#### \`foreground-scripts\` 3307#### \`ignore-scripts\` 3308#### \`audit\` 3309#### \`bin-links\` 3310#### \`fund\` 3311#### \`dry-run\` 3312#### \`cpu\` 3313#### \`os\` 3314#### \`libc\` 3315#### \`workspace\` 3316#### \`workspaces\` 3317#### \`include-workspace-root\` 3318#### \`install-links\` 3319` 3320 3321exports[`test/lib/docs.js TAP usage install-ci-test > must match snapshot 1`] = ` 3322Install a project with a clean slate and run tests 3323 3324Usage: 3325npm install-ci-test 3326 3327Options: 3328[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling] 3329[--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] 3330[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]] 3331[--strict-peer-deps] [--foreground-scripts] [--ignore-scripts] [--no-audit] 3332[--no-bin-links] [--no-fund] [--dry-run] 3333[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3334[-ws|--workspaces] [--include-workspace-root] [--install-links] 3335 3336aliases: cit, clean-install-test, sit 3337 3338Run "npm help install-ci-test" for more info 3339 3340\`\`\`bash 3341npm install-ci-test 3342 3343aliases: cit, clean-install-test, sit 3344\`\`\` 3345 3346#### \`install-strategy\` 3347#### \`legacy-bundling\` 3348#### \`global-style\` 3349#### \`omit\` 3350#### \`include\` 3351#### \`strict-peer-deps\` 3352#### \`foreground-scripts\` 3353#### \`ignore-scripts\` 3354#### \`audit\` 3355#### \`bin-links\` 3356#### \`fund\` 3357#### \`dry-run\` 3358#### \`workspace\` 3359#### \`workspaces\` 3360#### \`include-workspace-root\` 3361#### \`install-links\` 3362` 3363 3364exports[`test/lib/docs.js TAP usage install-test > must match snapshot 1`] = ` 3365Install package(s) and run tests 3366 3367Usage: 3368npm install-test [<package-spec> ...] 3369 3370Options: 3371[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle] 3372[-E|--save-exact] [-g|--global] 3373[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling] 3374[--global-style] [--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] 3375[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]] 3376[--strict-peer-deps] [--prefer-dedupe] [--no-package-lock] [--package-lock-only] 3377[--foreground-scripts] [--ignore-scripts] [--no-audit] [--no-bin-links] 3378[--no-fund] [--dry-run] [--cpu <cpu>] [--os <os>] [--libc <libc>] 3379[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3380[-ws|--workspaces] [--include-workspace-root] [--install-links] 3381 3382alias: it 3383 3384Run "npm help install-test" for more info 3385 3386\`\`\`bash 3387npm install-test [<package-spec> ...] 3388 3389alias: it 3390\`\`\` 3391 3392#### \`save\` 3393#### \`save-exact\` 3394#### \`global\` 3395#### \`install-strategy\` 3396#### \`legacy-bundling\` 3397#### \`global-style\` 3398#### \`omit\` 3399#### \`include\` 3400#### \`strict-peer-deps\` 3401#### \`prefer-dedupe\` 3402#### \`package-lock\` 3403#### \`package-lock-only\` 3404#### \`foreground-scripts\` 3405#### \`ignore-scripts\` 3406#### \`audit\` 3407#### \`bin-links\` 3408#### \`fund\` 3409#### \`dry-run\` 3410#### \`cpu\` 3411#### \`os\` 3412#### \`libc\` 3413#### \`workspace\` 3414#### \`workspaces\` 3415#### \`include-workspace-root\` 3416#### \`install-links\` 3417` 3418 3419exports[`test/lib/docs.js TAP usage link > must match snapshot 1`] = ` 3420Symlink a package folder 3421 3422Usage: 3423npm link [<package-spec>] 3424 3425Options: 3426[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle] 3427[-E|--save-exact] [-g|--global] 3428[--install-strategy <hoisted|nested|shallow|linked>] [--legacy-bundling] 3429[--global-style] [--strict-peer-deps] [--no-package-lock] 3430[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] 3431[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]] 3432[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run] 3433[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3434[-ws|--workspaces] [--include-workspace-root] [--install-links] 3435 3436alias: ln 3437 3438Run "npm help link" for more info 3439 3440\`\`\`bash 3441npm link [<package-spec>] 3442 3443alias: ln 3444\`\`\` 3445 3446#### \`save\` 3447#### \`save-exact\` 3448#### \`global\` 3449#### \`install-strategy\` 3450#### \`legacy-bundling\` 3451#### \`global-style\` 3452#### \`strict-peer-deps\` 3453#### \`package-lock\` 3454#### \`omit\` 3455#### \`include\` 3456#### \`ignore-scripts\` 3457#### \`audit\` 3458#### \`bin-links\` 3459#### \`fund\` 3460#### \`dry-run\` 3461#### \`workspace\` 3462#### \`workspaces\` 3463#### \`include-workspace-root\` 3464#### \`install-links\` 3465` 3466 3467exports[`test/lib/docs.js TAP usage ll > must match snapshot 1`] = ` 3468List installed packages 3469 3470Usage: 3471npm ll [[<@scope>/]<pkg> ...] 3472 3473Options: 3474[-a|--all] [--json] [-l|--long] [-p|--parseable] [-g|--global] [--depth <depth>] 3475[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] 3476[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]] 3477[--link] [--package-lock-only] [--unicode] 3478[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3479[-ws|--workspaces] [--include-workspace-root] [--install-links] 3480 3481alias: la 3482 3483Run "npm help ll" for more info 3484 3485\`\`\`bash 3486npm ll [[<@scope>/]<pkg> ...] 3487 3488alias: la 3489\`\`\` 3490 3491#### \`all\` 3492#### \`json\` 3493#### \`long\` 3494#### \`parseable\` 3495#### \`global\` 3496#### \`depth\` 3497#### \`omit\` 3498#### \`include\` 3499#### \`link\` 3500#### \`package-lock-only\` 3501#### \`unicode\` 3502#### \`workspace\` 3503#### \`workspaces\` 3504#### \`include-workspace-root\` 3505#### \`install-links\` 3506` 3507 3508exports[`test/lib/docs.js TAP usage login > must match snapshot 1`] = ` 3509Login to a registry user account 3510 3511Usage: 3512npm login 3513 3514Options: 3515[--registry <registry>] [--scope <@scope>] [--auth-type <legacy|web>] 3516 3517Run "npm help login" for more info 3518 3519\`\`\`bash 3520npm login 3521\`\`\` 3522 3523Note: This command is unaware of workspaces. 3524 3525#### \`registry\` 3526#### \`scope\` 3527#### \`auth-type\` 3528` 3529 3530exports[`test/lib/docs.js TAP usage logout > must match snapshot 1`] = ` 3531Log out of the registry 3532 3533Usage: 3534npm logout 3535 3536Options: 3537[--registry <registry>] [--scope <@scope>] 3538 3539Run "npm help logout" for more info 3540 3541\`\`\`bash 3542npm logout 3543\`\`\` 3544 3545Note: This command is unaware of workspaces. 3546 3547#### \`registry\` 3548#### \`scope\` 3549` 3550 3551exports[`test/lib/docs.js TAP usage ls > must match snapshot 1`] = ` 3552List installed packages 3553 3554Usage: 3555npm ls <package-spec> 3556 3557Options: 3558[-a|--all] [--json] [-l|--long] [-p|--parseable] [-g|--global] [--depth <depth>] 3559[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] 3560[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]] 3561[--link] [--package-lock-only] [--unicode] 3562[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3563[-ws|--workspaces] [--include-workspace-root] [--install-links] 3564 3565alias: list 3566 3567Run "npm help ls" for more info 3568 3569\`\`\`bash 3570npm ls <package-spec> 3571 3572alias: list 3573\`\`\` 3574 3575#### \`all\` 3576#### \`json\` 3577#### \`long\` 3578#### \`parseable\` 3579#### \`global\` 3580#### \`depth\` 3581#### \`omit\` 3582#### \`include\` 3583#### \`link\` 3584#### \`package-lock-only\` 3585#### \`unicode\` 3586#### \`workspace\` 3587#### \`workspaces\` 3588#### \`include-workspace-root\` 3589#### \`install-links\` 3590` 3591 3592exports[`test/lib/docs.js TAP usage npm > must match snapshot 1`] = ` 3593\`\`\`bash 3594npm 3595\`\`\` 3596 3597Note: This command is unaware of workspaces. 3598 3599NO PARAMS 3600` 3601 3602exports[`test/lib/docs.js TAP usage npx > must match snapshot 1`] = ` 3603\`\`\`bash 3604npx -- <pkg>[@<version>] [args...] 3605npx --package=<pkg>[@<version>] -- <cmd> [args...] 3606npx -c '<cmd> [args...]' 3607npx --package=foo -c '<cmd> [args...]' 3608\`\`\` 3609 3610NO PARAMS 3611` 3612 3613exports[`test/lib/docs.js TAP usage org > must match snapshot 1`] = ` 3614Manage orgs 3615 3616Usage: 3617npm org set orgname username [developer | admin | owner] 3618npm org rm orgname username 3619npm org ls orgname [<username>] 3620 3621Options: 3622[--registry <registry>] [--otp <otp>] [--json] [-p|--parseable] 3623 3624alias: ogr 3625 3626Run "npm help org" for more info 3627 3628\`\`\`bash 3629npm org set orgname username [developer | admin | owner] 3630npm org rm orgname username 3631npm org ls orgname [<username>] 3632 3633alias: ogr 3634\`\`\` 3635 3636Note: This command is unaware of workspaces. 3637 3638#### \`registry\` 3639#### \`otp\` 3640#### \`json\` 3641#### \`parseable\` 3642` 3643 3644exports[`test/lib/docs.js TAP usage outdated > must match snapshot 1`] = ` 3645Check for outdated packages 3646 3647Usage: 3648npm outdated [<package-spec> ...] 3649 3650Options: 3651[-a|--all] [--json] [-l|--long] [-p|--parseable] [-g|--global] 3652[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3653 3654Run "npm help outdated" for more info 3655 3656\`\`\`bash 3657npm outdated [<package-spec> ...] 3658\`\`\` 3659 3660#### \`all\` 3661#### \`json\` 3662#### \`long\` 3663#### \`parseable\` 3664#### \`global\` 3665#### \`workspace\` 3666` 3667 3668exports[`test/lib/docs.js TAP usage owner > must match snapshot 1`] = ` 3669Manage package owners 3670 3671Usage: 3672npm owner add <user> <package-spec> 3673npm owner rm <user> <package-spec> 3674npm owner ls <package-spec> 3675 3676Options: 3677[--registry <registry>] [--otp <otp>] 3678[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3679[-ws|--workspaces] 3680 3681alias: author 3682 3683Run "npm help owner" for more info 3684 3685\`\`\`bash 3686npm owner add <user> <package-spec> 3687npm owner rm <user> <package-spec> 3688npm owner ls <package-spec> 3689 3690alias: author 3691\`\`\` 3692 3693#### \`registry\` 3694#### \`otp\` 3695#### \`workspace\` 3696#### \`workspaces\` 3697` 3698 3699exports[`test/lib/docs.js TAP usage pack > must match snapshot 1`] = ` 3700Create a tarball from a package 3701 3702Usage: 3703npm pack <package-spec> 3704 3705Options: 3706[--dry-run] [--json] [--pack-destination <pack-destination>] 3707[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3708[-ws|--workspaces] [--include-workspace-root] 3709 3710Run "npm help pack" for more info 3711 3712\`\`\`bash 3713npm pack <package-spec> 3714\`\`\` 3715 3716#### \`dry-run\` 3717#### \`json\` 3718#### \`pack-destination\` 3719#### \`workspace\` 3720#### \`workspaces\` 3721#### \`include-workspace-root\` 3722` 3723 3724exports[`test/lib/docs.js TAP usage ping > must match snapshot 1`] = ` 3725Ping npm registry 3726 3727Usage: 3728npm ping 3729 3730Options: 3731[--registry <registry>] 3732 3733Run "npm help ping" for more info 3734 3735\`\`\`bash 3736npm ping 3737\`\`\` 3738 3739Note: This command is unaware of workspaces. 3740 3741#### \`registry\` 3742` 3743 3744exports[`test/lib/docs.js TAP usage pkg > must match snapshot 1`] = ` 3745Manages your package.json 3746 3747Usage: 3748npm pkg set <key>=<value> [<key>=<value> ...] 3749npm pkg get [<key> [<key> ...]] 3750npm pkg delete <key> [<key> ...] 3751npm pkg set [<array>[<index>].<key>=<value> ...] 3752npm pkg set [<array>[].<key>=<value> ...] 3753npm pkg fix 3754 3755Options: 3756[-f|--force] [--json] 3757[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3758[-ws|--workspaces] 3759 3760Run "npm help pkg" for more info 3761 3762\`\`\`bash 3763npm pkg set <key>=<value> [<key>=<value> ...] 3764npm pkg get [<key> [<key> ...]] 3765npm pkg delete <key> [<key> ...] 3766npm pkg set [<array>[<index>].<key>=<value> ...] 3767npm pkg set [<array>[].<key>=<value> ...] 3768npm pkg fix 3769\`\`\` 3770 3771#### \`force\` 3772#### \`json\` 3773#### \`workspace\` 3774#### \`workspaces\` 3775` 3776 3777exports[`test/lib/docs.js TAP usage prefix > must match snapshot 1`] = ` 3778Display prefix 3779 3780Usage: 3781npm prefix [-g] 3782 3783Options: 3784[-g|--global] 3785 3786Run "npm help prefix" for more info 3787 3788\`\`\`bash 3789npm prefix [-g] 3790\`\`\` 3791 3792Note: This command is unaware of workspaces. 3793 3794#### \`global\` 3795` 3796 3797exports[`test/lib/docs.js TAP usage profile > must match snapshot 1`] = ` 3798Change settings on your registry profile 3799 3800Usage: 3801npm profile enable-2fa [auth-only|auth-and-writes] 3802npm profile disable-2fa 3803npm profile get [<key>] 3804npm profile set <key> <value> 3805 3806Options: 3807[--registry <registry>] [--json] [-p|--parseable] [--otp <otp>] 3808 3809Run "npm help profile" for more info 3810 3811\`\`\`bash 3812npm profile enable-2fa [auth-only|auth-and-writes] 3813npm profile disable-2fa 3814npm profile get [<key>] 3815npm profile set <key> <value> 3816\`\`\` 3817 3818Note: This command is unaware of workspaces. 3819 3820#### \`registry\` 3821#### \`json\` 3822#### \`parseable\` 3823#### \`otp\` 3824` 3825 3826exports[`test/lib/docs.js TAP usage prune > must match snapshot 1`] = ` 3827Remove extraneous packages 3828 3829Usage: 3830npm prune [[<@scope>/]<pkg>...] 3831 3832Options: 3833[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] 3834[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]] 3835[--dry-run] [--json] [--foreground-scripts] [--ignore-scripts] 3836[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3837[-ws|--workspaces] [--include-workspace-root] [--install-links] 3838 3839Run "npm help prune" for more info 3840 3841\`\`\`bash 3842npm prune [[<@scope>/]<pkg>...] 3843\`\`\` 3844 3845#### \`omit\` 3846#### \`include\` 3847#### \`dry-run\` 3848#### \`json\` 3849#### \`foreground-scripts\` 3850#### \`ignore-scripts\` 3851#### \`workspace\` 3852#### \`workspaces\` 3853#### \`include-workspace-root\` 3854#### \`install-links\` 3855` 3856 3857exports[`test/lib/docs.js TAP usage publish > must match snapshot 1`] = ` 3858Publish a package 3859 3860Usage: 3861npm publish <package-spec> 3862 3863Options: 3864[--tag <tag>] [--access <restricted|public>] [--dry-run] [--otp <otp>] 3865[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3866[-ws|--workspaces] [--include-workspace-root] 3867[--provenance|--provenance-file <file>] 3868 3869Run "npm help publish" for more info 3870 3871\`\`\`bash 3872npm publish <package-spec> 3873\`\`\` 3874 3875#### \`tag\` 3876#### \`access\` 3877#### \`dry-run\` 3878#### \`otp\` 3879#### \`workspace\` 3880#### \`workspaces\` 3881#### \`include-workspace-root\` 3882#### \`provenance\` 3883#### \`provenance-file\` 3884` 3885 3886exports[`test/lib/docs.js TAP usage query > must match snapshot 1`] = ` 3887Retrieve a filtered list of packages 3888 3889Usage: 3890npm query <selector> 3891 3892Options: 3893[-g|--global] 3894[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3895[-ws|--workspaces] [--include-workspace-root] [--package-lock-only] 3896[--expect-results|--expect-result-count <count>] 3897 3898Run "npm help query" for more info 3899 3900\`\`\`bash 3901npm query <selector> 3902\`\`\` 3903 3904#### \`global\` 3905#### \`workspace\` 3906#### \`workspaces\` 3907#### \`include-workspace-root\` 3908#### \`package-lock-only\` 3909#### \`expect-results\` 3910#### \`expect-result-count\` 3911` 3912 3913exports[`test/lib/docs.js TAP usage rebuild > must match snapshot 1`] = ` 3914Rebuild a package 3915 3916Usage: 3917npm rebuild [<package-spec>] ...] 3918 3919Options: 3920[-g|--global] [--no-bin-links] [--foreground-scripts] [--ignore-scripts] 3921[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3922[-ws|--workspaces] [--include-workspace-root] [--install-links] 3923 3924alias: rb 3925 3926Run "npm help rebuild" for more info 3927 3928\`\`\`bash 3929npm rebuild [<package-spec>] ...] 3930 3931alias: rb 3932\`\`\` 3933 3934#### \`global\` 3935#### \`bin-links\` 3936#### \`foreground-scripts\` 3937#### \`ignore-scripts\` 3938#### \`workspace\` 3939#### \`workspaces\` 3940#### \`include-workspace-root\` 3941#### \`install-links\` 3942` 3943 3944exports[`test/lib/docs.js TAP usage repo > must match snapshot 1`] = ` 3945Open package repository page in the browser 3946 3947Usage: 3948npm repo [<pkgname> [<pkgname> ...]] 3949 3950Options: 3951[--no-browser|--browser <browser>] [--registry <registry>] 3952[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 3953[-ws|--workspaces] [--include-workspace-root] 3954 3955Run "npm help repo" for more info 3956 3957\`\`\`bash 3958npm repo [<pkgname> [<pkgname> ...]] 3959\`\`\` 3960 3961#### \`browser\` 3962#### \`registry\` 3963#### \`workspace\` 3964#### \`workspaces\` 3965#### \`include-workspace-root\` 3966` 3967 3968exports[`test/lib/docs.js TAP usage restart > must match snapshot 1`] = ` 3969Restart a package 3970 3971Usage: 3972npm restart [-- <args>] 3973 3974Options: 3975[--ignore-scripts] [--script-shell <script-shell>] 3976 3977Run "npm help restart" for more info 3978 3979\`\`\`bash 3980npm restart [-- <args>] 3981\`\`\` 3982 3983#### \`ignore-scripts\` 3984#### \`script-shell\` 3985` 3986 3987exports[`test/lib/docs.js TAP usage root > must match snapshot 1`] = ` 3988Display npm root 3989 3990Usage: 3991npm root 3992 3993Options: 3994[-g|--global] 3995 3996Run "npm help root" for more info 3997 3998\`\`\`bash 3999npm root 4000\`\`\` 4001 4002Note: This command is unaware of workspaces. 4003 4004#### \`global\` 4005` 4006 4007exports[`test/lib/docs.js TAP usage run-script > must match snapshot 1`] = ` 4008Run arbitrary package scripts 4009 4010Usage: 4011npm run-script <command> [-- <args>] 4012 4013Options: 4014[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 4015[-ws|--workspaces] [--include-workspace-root] [--if-present] [--ignore-scripts] 4016[--foreground-scripts] [--script-shell <script-shell>] 4017 4018aliases: run, rum, urn 4019 4020Run "npm help run-script" for more info 4021 4022\`\`\`bash 4023npm run-script <command> [-- <args>] 4024 4025aliases: run, rum, urn 4026\`\`\` 4027 4028#### \`workspace\` 4029#### \`workspaces\` 4030#### \`include-workspace-root\` 4031#### \`if-present\` 4032#### \`ignore-scripts\` 4033#### \`foreground-scripts\` 4034#### \`script-shell\` 4035` 4036 4037exports[`test/lib/docs.js TAP usage sbom > must match snapshot 1`] = ` 4038Generate a Software Bill of Materials (SBOM) 4039 4040Usage: 4041npm sbom 4042 4043Options: 4044[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] 4045[--package-lock-only] [--sbom-format <cyclonedx|spdx>] 4046[--sbom-type <library|application|framework>] 4047[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 4048[-ws|--workspaces] 4049 4050Run "npm help sbom" for more info 4051 4052\`\`\`bash 4053npm sbom 4054\`\`\` 4055 4056#### \`omit\` 4057#### \`package-lock-only\` 4058#### \`sbom-format\` 4059#### \`sbom-type\` 4060#### \`workspace\` 4061#### \`workspaces\` 4062` 4063 4064exports[`test/lib/docs.js TAP usage search > must match snapshot 1`] = ` 4065Search for packages 4066 4067Usage: 4068npm search [search terms ...] 4069 4070Options: 4071[-l|--long] [--json] [--color|--no-color|--color always] [-p|--parseable] 4072[--no-description] [--searchopts <searchopts>] [--searchexclude <searchexclude>] 4073[--registry <registry>] [--prefer-online] [--prefer-offline] [--offline] 4074 4075aliases: find, s, se 4076 4077Run "npm help search" for more info 4078 4079\`\`\`bash 4080npm search [search terms ...] 4081 4082aliases: find, s, se 4083\`\`\` 4084 4085Note: This command is unaware of workspaces. 4086 4087#### \`long\` 4088#### \`json\` 4089#### \`color\` 4090#### \`parseable\` 4091#### \`description\` 4092#### \`searchopts\` 4093#### \`searchexclude\` 4094#### \`registry\` 4095#### \`prefer-online\` 4096#### \`prefer-offline\` 4097#### \`offline\` 4098` 4099 4100exports[`test/lib/docs.js TAP usage set > must match snapshot 1`] = ` 4101Set a value in the npm configuration 4102 4103Usage: 4104npm set <key>=<value> [<key>=<value> ...] (See \`npm config\`) 4105 4106Options: 4107[-g|--global] [-L|--location <global|user|project>] 4108 4109Run "npm help set" for more info 4110 4111\`\`\`bash 4112npm set <key>=<value> [<key>=<value> ...] (See \`npm config\`) 4113\`\`\` 4114 4115Note: This command is unaware of workspaces. 4116 4117#### \`global\` 4118#### \`location\` 4119` 4120 4121exports[`test/lib/docs.js TAP usage shrinkwrap > must match snapshot 1`] = ` 4122Lock down dependency versions for publication 4123 4124Usage: 4125npm shrinkwrap 4126 4127Run "npm help shrinkwrap" for more info 4128 4129\`\`\`bash 4130npm shrinkwrap 4131\`\`\` 4132 4133Note: This command is unaware of workspaces. 4134 4135NO PARAMS 4136` 4137 4138exports[`test/lib/docs.js TAP usage star > must match snapshot 1`] = ` 4139Mark your favorite packages 4140 4141Usage: 4142npm star [<package-spec>...] 4143 4144Options: 4145[--registry <registry>] [--unicode] [--otp <otp>] 4146 4147Run "npm help star" for more info 4148 4149\`\`\`bash 4150npm star [<package-spec>...] 4151\`\`\` 4152 4153Note: This command is unaware of workspaces. 4154 4155#### \`registry\` 4156#### \`unicode\` 4157#### \`otp\` 4158` 4159 4160exports[`test/lib/docs.js TAP usage stars > must match snapshot 1`] = ` 4161View packages marked as favorites 4162 4163Usage: 4164npm stars [<user>] 4165 4166Options: 4167[--registry <registry>] 4168 4169Run "npm help stars" for more info 4170 4171\`\`\`bash 4172npm stars [<user>] 4173\`\`\` 4174 4175Note: This command is unaware of workspaces. 4176 4177#### \`registry\` 4178` 4179 4180exports[`test/lib/docs.js TAP usage start > must match snapshot 1`] = ` 4181Start a package 4182 4183Usage: 4184npm start [-- <args>] 4185 4186Options: 4187[--ignore-scripts] [--script-shell <script-shell>] 4188 4189Run "npm help start" for more info 4190 4191\`\`\`bash 4192npm start [-- <args>] 4193\`\`\` 4194 4195#### \`ignore-scripts\` 4196#### \`script-shell\` 4197` 4198 4199exports[`test/lib/docs.js TAP usage stop > must match snapshot 1`] = ` 4200Stop a package 4201 4202Usage: 4203npm stop [-- <args>] 4204 4205Options: 4206[--ignore-scripts] [--script-shell <script-shell>] 4207 4208Run "npm help stop" for more info 4209 4210\`\`\`bash 4211npm stop [-- <args>] 4212\`\`\` 4213 4214#### \`ignore-scripts\` 4215#### \`script-shell\` 4216` 4217 4218exports[`test/lib/docs.js TAP usage team > must match snapshot 1`] = ` 4219Manage organization teams and team memberships 4220 4221Usage: 4222npm team create <scope:team> [--otp <otpcode>] 4223npm team destroy <scope:team> [--otp <otpcode>] 4224npm team add <scope:team> <user> [--otp <otpcode>] 4225npm team rm <scope:team> <user> [--otp <otpcode>] 4226npm team ls <scope>|<scope:team> 4227 4228Options: 4229[--registry <registry>] [--otp <otp>] [-p|--parseable] [--json] 4230 4231Run "npm help team" for more info 4232 4233\`\`\`bash 4234npm team create <scope:team> [--otp <otpcode>] 4235npm team destroy <scope:team> [--otp <otpcode>] 4236npm team add <scope:team> <user> [--otp <otpcode>] 4237npm team rm <scope:team> <user> [--otp <otpcode>] 4238npm team ls <scope>|<scope:team> 4239\`\`\` 4240 4241Note: This command is unaware of workspaces. 4242 4243#### \`registry\` 4244#### \`otp\` 4245#### \`parseable\` 4246#### \`json\` 4247` 4248 4249exports[`test/lib/docs.js TAP usage test > must match snapshot 1`] = ` 4250Test a package 4251 4252Usage: 4253npm test [-- <args>] 4254 4255Options: 4256[--ignore-scripts] [--script-shell <script-shell>] 4257 4258aliases: tst, t 4259 4260Run "npm help test" for more info 4261 4262\`\`\`bash 4263npm test [-- <args>] 4264 4265aliases: tst, t 4266\`\`\` 4267 4268#### \`ignore-scripts\` 4269#### \`script-shell\` 4270` 4271 4272exports[`test/lib/docs.js TAP usage token > must match snapshot 1`] = ` 4273Manage your authentication tokens 4274 4275Usage: 4276npm token list 4277npm token revoke <id|token> 4278npm token create [--read-only] [--cidr=list] 4279 4280Options: 4281[--read-only] [--cidr <cidr> [--cidr <cidr> ...]] [--registry <registry>] 4282[--otp <otp>] 4283 4284Run "npm help token" for more info 4285 4286\`\`\`bash 4287npm token list 4288npm token revoke <id|token> 4289npm token create [--read-only] [--cidr=list] 4290\`\`\` 4291 4292Note: This command is unaware of workspaces. 4293 4294#### \`read-only\` 4295#### \`cidr\` 4296#### \`registry\` 4297#### \`otp\` 4298` 4299 4300exports[`test/lib/docs.js TAP usage uninstall > must match snapshot 1`] = ` 4301Remove a package 4302 4303Usage: 4304npm uninstall [<@scope>/]<pkg>... 4305 4306Options: 4307[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle] 4308[-g|--global] 4309[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 4310[-ws|--workspaces] [--include-workspace-root] [--install-links] 4311 4312aliases: unlink, remove, rm, r, un 4313 4314Run "npm help uninstall" for more info 4315 4316\`\`\`bash 4317npm uninstall [<@scope>/]<pkg>... 4318 4319aliases: unlink, remove, rm, r, un 4320\`\`\` 4321 4322#### \`save\` 4323#### \`global\` 4324#### \`workspace\` 4325#### \`workspaces\` 4326#### \`include-workspace-root\` 4327#### \`install-links\` 4328` 4329 4330exports[`test/lib/docs.js TAP usage unpublish > must match snapshot 1`] = ` 4331Remove a package from the registry 4332 4333Usage: 4334npm unpublish [<package-spec>] 4335 4336Options: 4337[--dry-run] [-f|--force] 4338[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 4339[-ws|--workspaces] 4340 4341Run "npm help unpublish" for more info 4342 4343\`\`\`bash 4344npm unpublish [<package-spec>] 4345\`\`\` 4346 4347#### \`dry-run\` 4348#### \`force\` 4349#### \`workspace\` 4350#### \`workspaces\` 4351` 4352 4353exports[`test/lib/docs.js TAP usage unstar > must match snapshot 1`] = ` 4354Remove an item from your favorite packages 4355 4356Usage: 4357npm unstar [<package-spec>...] 4358 4359Options: 4360[--registry <registry>] [--unicode] [--otp <otp>] 4361 4362Run "npm help unstar" for more info 4363 4364\`\`\`bash 4365npm unstar [<package-spec>...] 4366\`\`\` 4367 4368Note: This command is unaware of workspaces. 4369 4370#### \`registry\` 4371#### \`unicode\` 4372#### \`otp\` 4373` 4374 4375exports[`test/lib/docs.js TAP usage update > must match snapshot 1`] = ` 4376Update packages 4377 4378Usage: 4379npm update [<pkg>...] 4380 4381Options: 4382[-S|--save|--no-save|--save-prod|--save-dev|--save-optional|--save-peer|--save-bundle] 4383[-g|--global] [--install-strategy <hoisted|nested|shallow|linked>] 4384[--legacy-bundling] [--global-style] 4385[--omit <dev|optional|peer> [--omit <dev|optional|peer> ...]] 4386[--include <prod|dev|optional|peer> [--include <prod|dev|optional|peer> ...]] 4387[--strict-peer-deps] [--no-package-lock] [--foreground-scripts] 4388[--ignore-scripts] [--no-audit] [--no-bin-links] [--no-fund] [--dry-run] 4389[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 4390[-ws|--workspaces] [--include-workspace-root] [--install-links] 4391 4392aliases: up, upgrade, udpate 4393 4394Run "npm help update" for more info 4395 4396\`\`\`bash 4397npm update [<pkg>...] 4398 4399aliases: up, upgrade, udpate 4400\`\`\` 4401 4402#### \`save\` 4403#### \`global\` 4404#### \`install-strategy\` 4405#### \`legacy-bundling\` 4406#### \`global-style\` 4407#### \`omit\` 4408#### \`include\` 4409#### \`strict-peer-deps\` 4410#### \`package-lock\` 4411#### \`foreground-scripts\` 4412#### \`ignore-scripts\` 4413#### \`audit\` 4414#### \`bin-links\` 4415#### \`fund\` 4416#### \`dry-run\` 4417#### \`workspace\` 4418#### \`workspaces\` 4419#### \`include-workspace-root\` 4420#### \`install-links\` 4421` 4422 4423exports[`test/lib/docs.js TAP usage version > must match snapshot 1`] = ` 4424Bump a package version 4425 4426Usage: 4427npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git] 4428 4429Options: 4430[--allow-same-version] [--no-commit-hooks] [--no-git-tag-version] [--json] 4431[--preid prerelease-id] [--sign-git-tag] 4432[-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 4433[-ws|--workspaces] [--no-workspaces-update] [--include-workspace-root] 4434 4435alias: verison 4436 4437Run "npm help version" for more info 4438 4439\`\`\`bash 4440npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git] 4441 4442alias: verison 4443\`\`\` 4444 4445#### \`allow-same-version\` 4446#### \`commit-hooks\` 4447#### \`git-tag-version\` 4448#### \`json\` 4449#### \`preid\` 4450#### \`sign-git-tag\` 4451#### \`workspace\` 4452#### \`workspaces\` 4453#### \`workspaces-update\` 4454#### \`include-workspace-root\` 4455` 4456 4457exports[`test/lib/docs.js TAP usage view > must match snapshot 1`] = ` 4458View registry info 4459 4460Usage: 4461npm view [<package-spec>] [<field>[.subfield]...] 4462 4463Options: 4464[--json] [-w|--workspace <workspace-name> [-w|--workspace <workspace-name> ...]] 4465[-ws|--workspaces] [--include-workspace-root] 4466 4467aliases: info, show, v 4468 4469Run "npm help view" for more info 4470 4471\`\`\`bash 4472npm view [<package-spec>] [<field>[.subfield]...] 4473 4474aliases: info, show, v 4475\`\`\` 4476 4477#### \`json\` 4478#### \`workspace\` 4479#### \`workspaces\` 4480#### \`include-workspace-root\` 4481` 4482 4483exports[`test/lib/docs.js TAP usage whoami > must match snapshot 1`] = ` 4484Display npm username 4485 4486Usage: 4487npm whoami 4488 4489Options: 4490[--registry <registry>] 4491 4492Run "npm help whoami" for more info 4493 4494\`\`\`bash 4495npm whoami 4496\`\`\` 4497 4498Note: This command is unaware of workspaces. 4499 4500#### \`registry\` 4501` 4502