1CONFIG(7) CONFIG(7)
2
6 config - More than you probably want to know about npm configuration
7 Description
9 npm gets its configuration values from the following sources, sorted by
10 priority:
11 Command Line Flags
13 Putting --foo bar on the command line sets the foo configuration param‐
14 eter to "bar". A -- argument tells the cli parser to stop reading
15 flags. Using --flag without specifying any value will set the value to
16 true.
17 Example: --flag1 --flag2 will set both configuration parameters to
19 true, while --flag1 --flag2 bar will set flag1 to true, and flag2 to
20 bar. Finally, --flag1 --flag2 -- bar will set both configuration pa‐
21 rameters to true, and the bar is taken as a command argument.
22 Environment Variables
24 Any environment variables that start with npm_config_ will be inter‐
25 preted as a configuration parameter. For example, putting npm_con‐
26 fig_foo=bar in your environment will set the foo configuration parame‐
27 ter to bar. Any environment configurations that are not given a value
28 will be given the value of true. Config values are case-insensitive,
29 so NPM_CONFIG_FOO=bar will work the same. However, please note that in‐
30 side npm help scripts npm will set its own environment variables and
31 Node will prefer those lowercase versions over any uppercase ones that
32 you might set. For details see this issue
33 https://github.com/npm/npm/issues/14528.
34 Notice that you need to use underscores instead of dashes, so --al‐
36 low-same-version would become npm_config_allow_same_version=true.
37 npmrc Files
39 The four relevant files are:
40 • per-project configuration file (/path/to/my/project/.npmrc)
42 • per-user configuration file (defaults to $HOME/.npmrc; configurable
44 via CLI option --userconfig or environment variable $NPM_CONFIG_USER‐
45 CONFIG)
46 • global configuration file (defaults to $PREFIX/etc/npmrc; config‐
48 urable via CLI option --globalconfig or environment variable
49 $NPM_CONFIG_GLOBALCONFIG)
50 • npm's built-in configuration file (/path/to/npm/npmrc)
52 See npm help npmrc for more details.
55 Default Configs
57 Run npm config ls -l to see a set of configuration parameters that are
58 internal to npm, and are defaults if nothing else is specified.
59 Shorthands and Other CLI Niceties
61 The following shorthands are parsed on the command-line: <!-- AUTOGEN‐
62 ERATED CONFIG SHORTHANDS START --> <!-- automatically generated, do not
63 edit manually --> <!-- see lib/utils/config/definitions.js -->
64 • -a: --all
66 • --enjoy-by: --before
68 • -c: --call
70 • --desc: --description
72 • -f: --force
74 • -g: --global
76 • -L: --location
78 • -d: --loglevel info
80 • -s: --loglevel silent
82 • --silent: --loglevel silent
84 • --ddd: --loglevel silly
86 • --dd: --loglevel verbose
88 • --verbose: --loglevel verbose
90 • -q: --loglevel warn
92 • --quiet: --loglevel warn
94 • -l: --long
96 • -m: --message
98 • --local: --no-global
100 • -n: --no-yes
102 • --no: --no-yes
104 • -p: --parseable
106 • --porcelain: --parseable
108 • -C: --prefix
110 • --readonly: --read-only
112 • --reg: --registry
114 • -S: --save
116 • -B: --save-bundle
118 • -D: --save-dev
120 • -E: --save-exact
122 • -O: --save-optional
124 • -P: --save-prod
126 • -?: --usage
128 • -h: --usage
130 • -H: --usage
132 • --help: --usage
134 • -v: --version
136 • -w: --workspace
138 • --ws: --workspaces
140 • -y: --yes
142 <!-- automatically generated, do not edit manually --> <!-- see
144 lib/utils/config/definitions.js --> <!-- AUTOGENERATED CONFIG SHORT‐
145 HANDS END -->
146 If the specified configuration param resolves unambiguously to a known
149 configuration parameter, then it is expanded to that configuration pa‐
150 rameter. For example:
151 npm ls --par
153 # same as:
154 npm ls --parseable
155 If multiple single-character shorthands are strung together, and the
157 resulting combination is unambiguously not some other configuration
158 param, then it is expanded to its various component pieces. For exam‐
159 ple:
160 npm ls -gpld
162 # same as:
163 npm ls --global --parseable --long --loglevel info
164 Config Settings
166 <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically
167 generated, do not edit manually --> <!-- see lib/utils/config/defini‐
168 tions.js -->
169 _auth
171 • Default: null
172 • Type: null or String
174 A basic-auth string to use when authenticating against the npm reg‐
177 istry.
178 Warning: This should generally not be set via a command-line option. It
180 is safer to use a registry-provided authentication bearer token stored
181 in the ~/.npmrc file by running npm login. <!-- automatically gener‐
182 ated, do not edit manually --> <!-- see lib/utils/config/definitions.js
183 -->
184 access
187 • Default: 'restricted' for scoped packages, 'public' for unscoped
188 packages
189 • Type: null, "restricted", or "public"
191 When publishing scoped packages, the access level defaults to re‐
194 stricted. If you want your scoped package to be publicly viewable (and
195 installable) set --access=public. The only valid values for access are
196 public and restricted. Unscoped packages always have an access level of
197 public.
198 Note: Using the --access flag on the npm publish command will only set
200 the package access level on the initial publish of the package. Any
201 subsequent npm publish commands using the --access flag will not have
202 an effect to the access level. To make changes to the access level af‐
203 ter the initial publish use npm access. <!-- automatically generated,
204 do not edit manually --> <!-- see lib/utils/config/definitions.js -->
205 all
208 • Default: false
209 • Type: Boolean
211 When running npm outdated and npm ls, setting --all will show all out‐
214 dated or installed packages, rather than only those directly depended
215 upon by the current project. <!-- automatically generated, do not edit
216 manually --> <!-- see lib/utils/config/definitions.js -->
217 allow-same-version
220 • Default: false
221 • Type: Boolean
223 Prevents throwing an error when npm version is used to set the new ver‐
226 sion to the same value as the current version. <!-- automatically gen‐
227 erated, do not edit manually --> <!-- see lib/utils/config/defini‐
228 tions.js -->
229 audit
232 • Default: true
233 • Type: Boolean
235 When "true" submit audit reports alongside the current npm command to
238 the default registry and all registries configured for scopes. See the
239 documentation for npm help audit for details on what is submitted.
240 <!-- automatically generated, do not edit manually --> <!-- see
241 lib/utils/config/definitions.js -->
242 audit-level
245 • Default: null
246 • Type: null, "info", "low", "moderate", "high", "critical", or "none"
248 The minimum level of vulnerability for npm audit to exit with a
251 non-zero exit code. <!-- automatically generated, do not edit manually
252 --> <!-- see lib/utils/config/definitions.js -->
253 before
256 • Default: null
257 • Type: null or Date
259 If passed to npm install, will rebuild the npm tree such that only ver‐
262 sions that were available on or before the --before time get installed.
263 If there's no versions available for the current set of direct depen‐
264 dencies, the command will error.
265 If the requested version is a dist-tag and the given tag does not pass
267 the --before filter, the most recent version less than or equal to that
268 tag will be used. For example, foo@latest might install foo@1.2 even
269 though latest is 2.0. <!-- automatically generated, do not edit manu‐
270 ally --> <!-- see lib/utils/config/definitions.js -->
271 bin-links
274 • Default: true
275 • Type: Boolean
277 Tells npm to create symlinks (or .cmd shims on Windows) for package ex‐
280 ecutables.
281 Set to false to have it not do this. This can be used to work around
283 the fact that some file systems don't support symlinks, even on osten‐
284 sibly Unix systems. <!-- automatically generated, do not edit manually
285 --> <!-- see lib/utils/config/definitions.js -->
286 browser
289 • Default: OS X: "open", Windows: "start", Others: "xdg-open"
290 • Type: null, Boolean, or String
292 The browser that is called by npm commands to open websites.
295 Set to false to suppress browser behavior and instead print urls to
297 terminal.
298 Set to true to use default system URL opener. <!-- automatically gen‐
300 erated, do not edit manually --> <!-- see lib/utils/config/defini‐
301 tions.js -->
302 ca
305 • Default: null
306 • Type: null or String (can be set multiple times)
308 The Certificate Authority signing certificate that is trusted for SSL
311 connections to the registry. Values should be in PEM format (Windows
312 calls it "Base-64 encoded X.509 (.CER)") with newlines replaced by the
313 string "\n". For example:
314 ca="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"
316 Set to null to only allow "known" registrars, or to a specific CA cert
318 to trust only that specific signing authority.
319 Multiple CAs can be trusted by specifying an array of certificates:
321 ca[]="..."
323 ca[]="..."
324 See also the strict-ssl config. <!-- automatically generated, do not
326 edit manually --> <!-- see lib/utils/config/definitions.js -->
327 cache
330 • Default: Windows: %LocalAppData%\npm-cache, Posix: ~/.npm
331 • Type: Path
333 The location of npm's cache directory. See npm help npm cache <!-- au‐
336 tomatically generated, do not edit manually --> <!-- see lib/utils/con‐
337 fig/definitions.js -->
338 cafile
341 • Default: null
342 • Type: Path
344 A path to a file containing one or multiple Certificate Authority sign‐
347 ing certificates. Similar to the ca setting, but allows for multiple
348 CA's, as well as for the CA information to be stored in a file on disk.
349 <!-- automatically generated, do not edit manually --> <!-- see
350 lib/utils/config/definitions.js -->
351 call
354 • Default: ""
355 • Type: String
357 Optional companion option for npm exec, npx that allows for specifying
360 a custom command to be run along with the installed packages.
361 npm exec --package yo --package generator-node --call "yo node"
363 <!-- automatically generated, do not edit manually --> <!-- see
364 lib/utils/config/definitions.js -->
365 cert
368 • Default: null
369 • Type: null or String
371 A client certificate to pass when accessing the registry. Values should
374 be in PEM format (Windows calls it "Base-64 encoded X.509 (.CER)") with
375 newlines replaced by the string "\n". For example:
376 cert="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"
378 It is not the path to a certificate file (and there is no "certfile"
380 option). <!-- automatically generated, do not edit manually --> <!--
381 see lib/utils/config/definitions.js -->
382 ci-name
385 • Default: The name of the current CI system, or null when not on a
386 known CI platform.
387 • Type: null or String
389 The name of a continuous integration system. If not set explicitly, npm
392 will detect the current CI environment using the @npmcli/ci-detect
393 http://npm.im/@npmcli/ci-detect module. <!-- automatically generated,
394 do not edit manually --> <!-- see lib/utils/config/definitions.js -->
395 cidr
398 • Default: null
399 • Type: null or String (can be set multiple times)
401 This is a list of CIDR address to be used when configuring limited ac‐
404 cess tokens with the npm token create command. <!-- automatically gen‐
405 erated, do not edit manually --> <!-- see lib/utils/config/defini‐
406 tions.js -->
407 color
410 • Default: true unless the NO_COLOR environ is set to something other
411 than '0'
412 • Type: "always" or Boolean
414 If false, never shows colors. If "always" then always shows colors. If
417 true, then only prints color codes for tty file descriptors. <!-- au‐
418 tomatically generated, do not edit manually --> <!-- see lib/utils/con‐
419 fig/definitions.js -->
420 commit-hooks
423 • Default: true
424 • Type: Boolean
426 Run git commit hooks when using the npm version command. <!-- automat‐
429 ically generated, do not edit manually --> <!-- see lib/utils/con‐
430 fig/definitions.js -->
431 depth
434 • Default: Infinity if --all is set, otherwise 1
435 • Type: null or Number
437 The depth to go when recursing packages for npm ls.
440 If not set, npm ls will show only the immediate dependencies of the
442 root project. If --all is set, then npm will show all dependencies by
443 default. <!-- automatically generated, do not edit manually --> <!--
444 see lib/utils/config/definitions.js -->
445 description
448 • Default: true
449 • Type: Boolean
451 Show the description in npm search <!-- automatically generated, do not
454 edit manually --> <!-- see lib/utils/config/definitions.js -->
455 diff
458 • Default:
459 • Type: String (can be set multiple times)
461 Define arguments to compare in npm diff. <!-- automatically generated,
464 do not edit manually --> <!-- see lib/utils/config/definitions.js -->
465 diff-dst-prefix
468 • Default: "b/"
469 • Type: String
471 Destination prefix to be used in npm diff output. <!-- automatically
474 generated, do not edit manually --> <!-- see lib/utils/config/defini‐
475 tions.js -->
476 diff-ignore-all-space
479 • Default: false
480 • Type: Boolean
482 Ignore whitespace when comparing lines in npm diff. <!-- automatically
485 generated, do not edit manually --> <!-- see lib/utils/config/defini‐
486 tions.js -->
487 diff-name-only
490 • Default: false
491 • Type: Boolean
493 Prints only filenames when using npm diff. <!-- automatically gener‐
496 ated, do not edit manually --> <!-- see lib/utils/config/definitions.js
497 -->
498 diff-no-prefix
501 • Default: false
502 • Type: Boolean
504 Do not show any source or destination prefix in npm diff output.
507 Note: this causes npm diff to ignore the --diff-src-prefix and
509 --diff-dst-prefix configs. <!-- automatically generated, do not edit
510 manually --> <!-- see lib/utils/config/definitions.js -->
511 diff-src-prefix
514 • Default: "a/"
515 • Type: String
517 Source prefix to be used in npm diff output. <!-- automatically gener‐
520 ated, do not edit manually --> <!-- see lib/utils/config/definitions.js
521 -->
522 diff-text
525 • Default: false
526 • Type: Boolean
528 Treat all files as text in npm diff. <!-- automatically generated, do
531 not edit manually --> <!-- see lib/utils/config/definitions.js -->
532 diff-unified
535 • Default: 3
536 • Type: Number
538 The number of lines of context to print in npm diff. <!-- automati‐
541 cally generated, do not edit manually --> <!-- see lib/utils/con‐
542 fig/definitions.js -->
543 dry-run
546 • Default: false
547 • Type: Boolean
549 Indicates that you don't want npm to make any changes and that it
552 should only report what it would have done. This can be passed into any
553 of the commands that modify your local installation, eg, install, up‐
554 date, dedupe, uninstall, as well as pack and publish.
555 Note: This is NOT honored by other network related commands, eg
557 dist-tags, owner, etc. <!-- automatically generated, do not edit manu‐
558 ally --> <!-- see lib/utils/config/definitions.js -->
559 editor
562 • Default: The EDITOR or VISUAL environment variables, or 'notepad.exe'
563 on Windows, or 'vim' on Unix systems
564 • Type: String
566 The command to run for npm edit and npm config edit. <!-- automati‐
569 cally generated, do not edit manually --> <!-- see lib/utils/con‐
570 fig/definitions.js -->
571 engine-strict
574 • Default: false
575 • Type: Boolean
577 If set to true, then npm will stubbornly refuse to install (or even
580 consider installing) any package that claims to not be compatible with
581 the current Node.js version.
582 This can be overridden by setting the --force flag. <!-- automatically
584 generated, do not edit manually --> <!-- see lib/utils/config/defini‐
585 tions.js -->
586 fetch-retries
589 • Default: 2
590 • Type: Number
592 The "retries" config for the retry module to use when fetching packages
595 from the registry.
596 npm will retry idempotent read requests to the registry in the case of
598 network failures or 5xx HTTP errors. <!-- automatically generated, do
599 not edit manually --> <!-- see lib/utils/config/definitions.js -->
600 fetch-retry-factor
603 • Default: 10
604 • Type: Number
606 The "factor" config for the retry module to use when fetching packages.
609 <!-- automatically generated, do not edit manually --> <!-- see
610 lib/utils/config/definitions.js -->
611 fetch-retry-maxtimeout
614 • Default: 60000 (1 minute)
615 • Type: Number
617 The "maxTimeout" config for the retry module to use when fetching pack‐
620 ages. <!-- automatically generated, do not edit manually --> <!-- see
621 lib/utils/config/definitions.js -->
622 fetch-retry-mintimeout
625 • Default: 10000 (10 seconds)
626 • Type: Number
628 The "minTimeout" config for the retry module to use when fetching pack‐
631 ages. <!-- automatically generated, do not edit manually --> <!-- see
632 lib/utils/config/definitions.js -->
633 fetch-timeout
636 • Default: 300000 (5 minutes)
637 • Type: Number
639 The maximum amount of time to wait for HTTP requests to complete. <!--
642 automatically generated, do not edit manually --> <!-- see
643 lib/utils/config/definitions.js -->
644 force
647 • Default: false
648 • Type: Boolean
650 Removes various protections against unfortunate side effects, common
653 mistakes, unnecessary performance degradation, and malicious input.
654 • Allow clobbering non-npm files in global installs.
656 • Allow the npm version command to work on an unclean git repository.
658 • Allow deleting the cache folder with npm cache clean.
660 • Allow installing packages that have an engines declaration requiring
662 a different version of npm.
663 • Allow installing packages that have an engines declaration requiring
665 a different version of node, even if --engine-strict is enabled.
666 • Allow npm audit fix to install modules outside your stated dependency
668 range (including SemVer-major changes).
669 • Allow unpublishing all versions of a published package.
671 • Allow conflicting peerDependencies to be installed in the root
673 project.
674 • Implicitly set --yes during npm init.
676 • Allow clobbering existing values in npm pkg
678 If you don't have a clear idea of what you want to do, it is strongly
681 recommended that you do not use this option! <!-- automatically gener‐
682 ated, do not edit manually --> <!-- see lib/utils/config/definitions.js
683 -->
684 foreground-scripts
687 • Default: false
688 • Type: Boolean
690 Run all build scripts (ie, preinstall, install, and postinstall)
693 scripts for installed packages in the foreground process, sharing stan‐
694 dard input, output, and error with the main npm process.
695 Note that this will generally make installs run slower, and be much
697 noisier, but can be useful for debugging. <!-- automatically gener‐
698 ated, do not edit manually --> <!-- see lib/utils/config/definitions.js
699 -->
700 format-package-lock
703 • Default: true
704 • Type: Boolean
706 Format package-lock.json or npm-shrinkwrap.json as a human readable
709 file. <!-- automatically generated, do not edit manually --> <!-- see
710 lib/utils/config/definitions.js -->
711 fund
714 • Default: true
715 • Type: Boolean
717 When "true" displays the message at the end of each npm install ac‐
720 knowledging the number of dependencies looking for funding. See npm
721 help npm fund for details. <!-- automatically generated, do not edit
722 manually --> <!-- see lib/utils/config/definitions.js -->
723 git
726 • Default: "git"
727 • Type: String
729 The command to use for git commands. If git is installed on the com‐
732 puter, but is not in the PATH, then set this to the full path to the
733 git binary. <!-- automatically generated, do not edit manually -->
734 <!-- see lib/utils/config/definitions.js -->
735 git-tag-version
738 • Default: true
739 • Type: Boolean
741 Tag the commit when using the npm version command. <!-- automatically
744 generated, do not edit manually --> <!-- see lib/utils/config/defini‐
745 tions.js -->
746 global
749 • Default: false
750 • Type: Boolean
752 Operates in "global" mode, so that packages are installed into the pre‐
755 fix folder instead of the current working directory. See npm help fold‐
756 ers for more on the differences in behavior.
757 • packages are installed into the {prefix}/lib/node_modules folder, in‐
759 stead of the current working directory.
760 • bin files are linked to {prefix}/bin
762 • man pages are linked to {prefix}/share/man
764 <!-- automatically generated, do not edit manually --> <!-- see
766 lib/utils/config/definitions.js -->
767 global-style
770 • Default: false
771 • Type: Boolean
773 Causes npm to install the package into your local node_modules folder
776 with the same layout it uses with the global node_modules folder. Only
777 your direct dependencies will show in node_modules and everything they
778 depend on will be flattened in their node_modules folders. This obvi‐
779 ously will eliminate some deduping. If used with legacy-bundling,
780 legacy-bundling will be preferred. <!-- automatically generated, do
781 not edit manually --> <!-- see lib/utils/config/definitions.js -->
782 globalconfig
785 • Default: The global --prefix setting plus 'etc/npmrc'. For example,
786 '/usr/local/etc/npmrc'
787 • Type: Path
789 The config file to read for global config options. <!-- automatically
792 generated, do not edit manually --> <!-- see lib/utils/config/defini‐
793 tions.js -->
794 heading
797 • Default: "npm"
798 • Type: String
800 The string that starts all the debugging log output. <!-- automati‐
803 cally generated, do not edit manually --> <!-- see lib/utils/con‐
804 fig/definitions.js -->
805 https-proxy
808 • Default: null
809 • Type: null or URL
811 A proxy to use for outgoing https requests. If the HTTPS_PROXY or
814 https_proxy or HTTP_PROXY or http_proxy environment variables are set,
815 proxy settings will be honored by the underlying make-fetch-happen li‐
816 brary. <!-- automatically generated, do not edit manually --> <!-- see
817 lib/utils/config/definitions.js -->
818 if-present
821 • Default: false
822 • Type: Boolean
824 If true, npm will not exit with an error code when run-script is in‐
827 voked for a script that isn't defined in the scripts section of pack‐
828 age.json. This option can be used when it's desirable to optionally
829 run a script when it's present and fail if the script fails. This is
830 useful, for example, when running scripts that may only apply for some
831 builds in an otherwise generic CI setup. <!-- automatically generated,
832 do not edit manually --> <!-- see lib/utils/config/definitions.js -->
833 ignore-scripts
836 • Default: false
837 • Type: Boolean
839 If true, npm does not run scripts specified in package.json files.
842 Note that commands explicitly intended to run a particular script, such
844 as npm start, npm stop, npm restart, npm test, and npm run-script will
845 still run their intended script if ignore-scripts is set, but they will
846 not run any pre- or post-scripts. <!-- automatically generated, do not
847 edit manually --> <!-- see lib/utils/config/definitions.js -->
848 include
851 • Default:
852 • Type: "prod", "dev", "optional", or "peer" (can be set multiple
854 times)
855 Option that allows for defining which types of dependencies to install.
858 This is the inverse of --omit=<type>.
860 Dependency types specified in --include will not be omitted, regardless
862 of the order in which omit/include are specified on the command-line.
863 <!-- automatically generated, do not edit manually --> <!-- see
864 lib/utils/config/definitions.js -->
865 include-staged
868 • Default: false
869 • Type: Boolean
871 Allow installing "staged" published packages, as defined by npm RFC PR
874 #92 https://github.com/npm/rfcs/pull/92.
875 This is experimental, and not implemented by the npm public registry.
877 <!-- automatically generated, do not edit manually --> <!-- see
878 lib/utils/config/definitions.js -->
879 include-workspace-root
882 • Default: false
883 • Type: Boolean
885 Include the workspace root when workspaces are enabled for a command.
888 When false, specifying individual workspaces via the workspace config,
890 or all workspaces via the workspaces flag, will cause npm to operate
891 only on the specified workspaces, and not on the root project. <!--
892 automatically generated, do not edit manually --> <!-- see
893 lib/utils/config/definitions.js -->
894 init-author-email
897 • Default: ""
898 • Type: String
900 The value npm init should use by default for the package author's
903 email. <!-- automatically generated, do not edit manually --> <!-- see
904 lib/utils/config/definitions.js -->
905 init-author-name
908 • Default: ""
909 • Type: String
911 The value npm init should use by default for the package author's name.
914 <!-- automatically generated, do not edit manually --> <!-- see
915 lib/utils/config/definitions.js -->
916 init-author-url
919 • Default: ""
920 • Type: "" or URL
922 The value npm init should use by default for the package author's home‐
925 page. <!-- automatically generated, do not edit manually --> <!-- see
926 lib/utils/config/definitions.js -->
927 init-license
930 • Default: "ISC"
931 • Type: String
933 The value npm init should use by default for the package license. <!--
936 automatically generated, do not edit manually --> <!-- see
937 lib/utils/config/definitions.js -->
938 init-module
941 • Default: "~/.npm-init.js"
942 • Type: Path
944 A module that will be loaded by the npm init command. See the documen‐
947 tation for the init-package-json https://github.com/npm/init-pack‐
948 age-json module for more information, or npm help init. <!-- automati‐
949 cally generated, do not edit manually --> <!-- see lib/utils/con‐
950 fig/definitions.js -->
951 init-version
954 • Default: "1.0.0"
955 • Type: SemVer string
957 The value that npm init should use by default for the package version
960 number, if not already set in package.json. <!-- automatically gener‐
961 ated, do not edit manually --> <!-- see lib/utils/config/definitions.js
962 -->
963 json
966 • Default: false
967 • Type: Boolean
969 Whether or not to output JSON data, rather than the normal output.
972 • In npm pkg set it enables parsing set values with JSON.parse() before
974 saving them to your package.json.
975 Not supported by all npm commands. <!-- automatically generated, do
978 not edit manually --> <!-- see lib/utils/config/definitions.js -->
979 key
982 • Default: null
983 • Type: null or String
985 A client key to pass when accessing the registry. Values should be in
988 PEM format with newlines replaced by the string "\n". For example:
989 key="-----BEGIN PRIVATE KEY-----\nXXXX\nXXXX\n-----END PRIVATE KEY-----"
991 It is not the path to a key file (and there is no "keyfile" option).
993 <!-- automatically generated, do not edit manually --> <!-- see
994 lib/utils/config/definitions.js -->
995 legacy-bundling
998 • Default: false
999 • Type: Boolean
1001 Causes npm to install the package such that versions of npm prior to
1004 1.4, such as the one included with node 0.8, can install the package.
1005 This eliminates all automatic deduping. If used with global-style this
1006 option will be preferred. <!-- automatically generated, do not edit
1007 manually --> <!-- see lib/utils/config/definitions.js -->
1008 legacy-peer-deps
1011 • Default: false
1012 • Type: Boolean
1014 Causes npm to completely ignore peerDependencies when building a pack‐
1017 age tree, as in npm versions 3 through 6.
1018 If a package cannot be installed because of overly strict peerDependen‐
1020 cies that collide, it provides a way to move forward resolving the sit‐
1021 uation.
1022 This differs from --omit=peer, in that --omit=peer will avoid unpacking
1024 peerDependencies on disk, but will still design a tree such that
1025 peerDependencies could be unpacked in a correct place.
1026 Use of legacy-peer-deps is not recommended, as it will not enforce the
1028 peerDependencies contract that meta-dependencies may rely on. <!-- au‐
1029 tomatically generated, do not edit manually --> <!-- see lib/utils/con‐
1030 fig/definitions.js -->
1031 link
1034 • Default: false
1035 • Type: Boolean
1037 Used with npm ls, limiting output to only those packages that are
1040 linked. <!-- automatically generated, do not edit manually --> <!--
1041 see lib/utils/config/definitions.js -->
1042 local-address
1045 • Default: null
1046 • Type: IP Address
1048 The IP address of the local interface to use when making connections to
1051 the npm registry. Must be IPv4 in versions of Node prior to 0.12. <!--
1052 automatically generated, do not edit manually --> <!-- see
1053 lib/utils/config/definitions.js -->
1054 location
1057 • Default: "user" unless --global is passed, which will also set this
1058 value to "global"
1059 • Type: "global", "user", or "project"
1061 When passed to npm config this refers to which config file to use.
1064 <!-- automatically generated, do not edit manually --> <!-- see
1065 lib/utils/config/definitions.js -->
1066 lockfile-version
1069 • Default: Version 2 if no lockfile or current lockfile version less
1070 than or equal to 2, otherwise maintain current lockfile version
1071 • Type: null, 1, 2, 3, "1", "2", or "3"
1073 Set the lockfile format version to be used in package-lock.json and
1076 npm-shrinkwrap-json files. Possible options are:
1077 1: The lockfile version used by npm versions 5 and 6. Lacks some data
1079 that is used during the install, resulting in slower and possibly less
1080 deterministic installs. Prevents lockfile churn when interoperating
1081 with older npm versions.
1082 2: The default lockfile version used by npm version 7. Includes both
1084 the version 1 lockfile data and version 3 lockfile data, for maximum
1085 determinism and interoperability, at the expense of more bytes on disk.
1086 3: Only the new lockfile information introduced in npm version 7.
1088 Smaller on disk than lockfile version 2, but not interoperable with
1089 older npm versions. Ideal if all users are on npm version 7 and
1090 higher. <!-- automatically generated, do not edit manually --> <!--
1091 see lib/utils/config/definitions.js -->
1092 loglevel
1095 • Default: "notice"
1096 • Type: "silent", "error", "warn", "notice", "http", "timing", "info",
1098 "verbose", or "silly"
1099 What level of logs to report. All logs are written to a debug log, with
1102 the path to that file printed if the execution of a command fails.
1103 Any logs of a higher level than the setting are shown. The default is
1105 "notice".
1106 See also the foreground-scripts config. <!-- automatically generated,
1108 do not edit manually --> <!-- see lib/utils/config/definitions.js -->
1109 logs-max
1112 • Default: 10
1113 • Type: Number
1115 The maximum number of log files to store. <!-- automatically gener‐
1118 ated, do not edit manually --> <!-- see lib/utils/config/definitions.js
1119 -->
1120 long
1123 • Default: false
1124 • Type: Boolean
1126 Show extended information in ls, search, and help-search. <!-- auto‐
1129 matically generated, do not edit manually --> <!-- see lib/utils/con‐
1130 fig/definitions.js -->
1131 maxsockets
1134 • Default: 15
1135 • Type: Number
1137 The maximum number of connections to use per origin (protocol/host/port
1140 combination). <!-- automatically generated, do not edit manually -->
1141 <!-- see lib/utils/config/definitions.js -->
1142 message
1145 • Default: "%s"
1146 • Type: String
1148 Commit message which is used by npm version when creating version com‐
1151 mit.
1152 Any "%s" in the message will be replaced with the version number. <!--
1154 automatically generated, do not edit manually --> <!-- see
1155 lib/utils/config/definitions.js -->
1156 node-options
1159 • Default: null
1160 • Type: null or String
1162 Options to pass through to Node.js via the NODE_OPTIONS environment
1165 variable. This does not impact how npm itself is executed but it does
1166 impact how lifecycle scripts are called. <!-- automatically generated,
1167 do not edit manually --> <!-- see lib/utils/config/definitions.js -->
1168 node-version
1171 • Default: Node.js process.version value
1172 • Type: SemVer string
1174 The node version to use when checking a package's engines setting.
1177 <!-- automatically generated, do not edit manually --> <!-- see
1178 lib/utils/config/definitions.js -->
1179 noproxy
1182 • Default: The value of the NO_PROXY environment variable
1183 • Type: String (can be set multiple times)
1185 Domain extensions that should bypass any proxies.
1188 Also accepts a comma-delimited string. <!-- automatically generated,
1190 do not edit manually --> <!-- see lib/utils/config/definitions.js -->
1191 npm-version
1194 • Default: Output of npm --version
1195 • Type: SemVer string
1197 The npm version to use when checking a package's engines setting. <!--
1200 automatically generated, do not edit manually --> <!-- see
1201 lib/utils/config/definitions.js -->
1202 offline
1205 • Default: false
1206 • Type: Boolean
1208 Force offline mode: no network requests will be done during install. To
1211 allow the CLI to fill in missing cache data, see --prefer-offline.
1212 <!-- automatically generated, do not edit manually --> <!-- see
1213 lib/utils/config/definitions.js -->
1214 omit
1217 • Default: 'dev' if the NODE_ENV environment variable is set to 'pro‐
1218 duction', otherwise empty.
1219 • Type: "dev", "optional", or "peer" (can be set multiple times)
1221 Dependency types to omit from the installation tree on disk.
1224 Note that these dependencies are still resolved and added to the pack‐
1226 age-lock.json or npm-shrinkwrap.json file. They are just not physically
1227 installed on disk.
1228 If a package type appears in both the --include and --omit lists, then
1230 it will be included.
1231 If the resulting omit list includes 'dev', then the NODE_ENV environ‐
1233 ment variable will be set to 'production' for all lifecycle scripts.
1234 <!-- automatically generated, do not edit manually --> <!-- see
1235 lib/utils/config/definitions.js -->
1236 otp
1239 • Default: null
1240 • Type: null or String
1242 This is a one-time password from a two-factor authenticator. It's
1245 needed when publishing or changing package permissions with npm access.
1246 If not set, and a registry response fails with a challenge for a
1248 one-time password, npm will prompt on the command line for one. <!--
1249 automatically generated, do not edit manually --> <!-- see
1250 lib/utils/config/definitions.js -->
1251 pack-destination
1254 • Default: "."
1255 • Type: String
1257 Directory in which npm pack will save tarballs. <!-- automatically
1260 generated, do not edit manually --> <!-- see lib/utils/config/defini‐
1261 tions.js -->
1262 package
1265 • Default:
1266 • Type: String (can be set multiple times)
1268 The package to install for npm help exec <!-- automatically generated,
1271 do not edit manually --> <!-- see lib/utils/config/definitions.js -->
1272 package-lock
1275 • Default: true
1276 • Type: Boolean
1278 If set to false, then ignore package-lock.json files when installing.
1281 This will also prevent writing package-lock.json if save is true.
1282 When package package-locks are disabled, automatic pruning of extrane‐
1284 ous modules will also be disabled. To remove extraneous modules with
1285 package-locks disabled use npm prune. <!-- automatically generated, do
1286 not edit manually --> <!-- see lib/utils/config/definitions.js -->
1287 package-lock-only
1290 • Default: false
1291 • Type: Boolean
1293 If set to true, the current operation will only use the pack‐
1296 age-lock.json, ignoring node_modules.
1297 For update this means only the package-lock.json will be updated, in‐
1299 stead of checking node_modules and downloading dependencies.
1300 For list this means the output will be based on the tree described by
1302 the package-lock.json, rather than the contents of node_modules. <!--
1303 automatically generated, do not edit manually --> <!-- see
1304 lib/utils/config/definitions.js -->
1305 parseable
1308 • Default: false
1309 • Type: Boolean
1311 Output parseable results from commands that write to standard output.
1314 For npm search, this will be tab-separated table format. <!-- automat‐
1315 ically generated, do not edit manually --> <!-- see lib/utils/con‐
1316 fig/definitions.js -->
1317 prefer-offline
1320 • Default: false
1321 • Type: Boolean
1323 If true, staleness checks for cached data will be bypassed, but missing
1326 data will be requested from the server. To force full offline mode, use
1327 --offline. <!-- automatically generated, do not edit manually --> <!--
1328 see lib/utils/config/definitions.js -->
1329 prefer-online
1332 • Default: false
1333 • Type: Boolean
1335 If true, staleness checks for cached data will be forced, making the
1338 CLI look for updates immediately even for fresh package data. <!-- au‐
1339 tomatically generated, do not edit manually --> <!-- see lib/utils/con‐
1340 fig/definitions.js -->
1341 prefix
1344 • Default: In global mode, the folder where the node executable is in‐
1345 stalled. In local mode, the nearest parent folder containing either
1346 a package.json file or a node_modules folder.
1347 • Type: Path
1349 The location to install global items. If set on the command line, then
1352 it forces non-global commands to run in the specified folder. <!-- au‐
1353 tomatically generated, do not edit manually --> <!-- see lib/utils/con‐
1354 fig/definitions.js -->
1355 preid
1358 • Default: ""
1359 • Type: String
1361 The "prerelease identifier" to use as a prefix for the "prerelease"
1364 part of a semver. Like the rc in 1.2.0-rc.8. <!-- automatically gener‐
1365 ated, do not edit manually --> <!-- see lib/utils/config/definitions.js
1366 -->
1367 progress
1370 • Default: true unless running in a known CI system
1371 • Type: Boolean
1373 When set to true, npm will display a progress bar during time intensive
1376 operations, if process.stderr is a TTY.
1377 Set to false to suppress the progress bar. <!-- automatically gener‐
1379 ated, do not edit manually --> <!-- see lib/utils/config/definitions.js
1380 -->
1381 proxy
1384 • Default: null
1385 • Type: null, false, or URL
1387 A proxy to use for outgoing http requests. If the HTTP_PROXY or
1390 http_proxy environment variables are set, proxy settings will be hon‐
1391 ored by the underlying request library. <!-- automatically generated,
1392 do not edit manually --> <!-- see lib/utils/config/definitions.js -->
1393 read-only
1396 • Default: false
1397 • Type: Boolean
1399 This is used to mark a token as unable to publish when configuring lim‐
1402 ited access tokens with the npm token create command. <!-- automati‐
1403 cally generated, do not edit manually --> <!-- see lib/utils/con‐
1404 fig/definitions.js -->
1405 rebuild-bundle
1408 • Default: true
1409 • Type: Boolean
1411 Rebuild bundled dependencies after installation. <!-- automatically
1414 generated, do not edit manually --> <!-- see lib/utils/config/defini‐
1415 tions.js -->
1416 registry
1419 • Default: "https://registry.npmjs.org/"
1420 • Type: URL
1422 The base URL of the npm registry. <!-- automatically generated, do not
1425 edit manually --> <!-- see lib/utils/config/definitions.js -->
1426 save
1429 • Default: true
1430 • Type: Boolean
1432 Save installed packages to a package.json file as dependencies.
1435 When used with the npm rm command, removes the dependency from pack‐
1437 age.json. <!-- automatically generated, do not edit manually --> <!--
1438 see lib/utils/config/definitions.js -->
1439 save-bundle
1442 • Default: false
1443 • Type: Boolean
1445 If a package would be saved at install time by the use of --save,
1448 --save-dev, or --save-optional, then also put it in the bundleDependen‐
1449 cies list.
1450 Ignore if --save-peer is set, since peerDependencies cannot be bundled.
1452 <!-- automatically generated, do not edit manually --> <!-- see
1453 lib/utils/config/definitions.js -->
1454 save-dev
1457 • Default: false
1458 • Type: Boolean
1460 Save installed packages to a package.json file as devDependencies.
1463 <!-- automatically generated, do not edit manually --> <!-- see
1464 lib/utils/config/definitions.js -->
1465 save-exact
1468 • Default: false
1469 • Type: Boolean
1471 Dependencies saved to package.json will be configured with an exact
1474 version rather than using npm's default semver range operator. <!--
1475 automatically generated, do not edit manually --> <!-- see
1476 lib/utils/config/definitions.js -->
1477 save-optional
1480 • Default: false
1481 • Type: Boolean
1483 Save installed packages to a package.json file as optionalDependencies.
1486 <!-- automatically generated, do not edit manually --> <!-- see
1487 lib/utils/config/definitions.js -->
1488 save-peer
1491 • Default: false
1492 • Type: Boolean
1494 Save installed packages to a package.json file as peerDependencies <!--
1497 automatically generated, do not edit manually --> <!-- see
1498 lib/utils/config/definitions.js -->
1499 save-prefix
1502 • Default: "^"
1503 • Type: String
1505 Configure how versions of packages installed to a package.json file via
1508 --save or --save-dev get prefixed.
1509 For example if a package has version 1.2.3, by default its version is
1511 set to ^1.2.3 which allows minor upgrades for that package, but after
1512 npm config set save-prefix='~' it would be set to ~1.2.3 which only al‐
1513 lows patch upgrades. <!-- automatically generated, do not edit manu‐
1514 ally --> <!-- see lib/utils/config/definitions.js -->
1515 save-prod
1518 • Default: false
1519 • Type: Boolean
1521 Save installed packages into dependencies specifically. This is useful
1524 if a package already exists in devDependencies or optionalDependencies,
1525 but you want to move it to be a non-optional production dependency.
1526 This is the default behavior if --save is true, and neither --save-dev
1528 or --save-optional are true. <!-- automatically generated, do not edit
1529 manually --> <!-- see lib/utils/config/definitions.js -->
1530 scope
1533 • Default: the scope of the current project, if any, or ""
1534 • Type: String
1536 Associate an operation with a scope for a scoped registry.
1539 Useful when logging in to or out of a private registry:
1541 # log in, linking the scope to the custom registry
1543 npm login --scope=@mycorp --registry=https://registry.mycorp.com
1544 # log out, removing the link and the auth token
1546 npm logout --scope=@mycorp
1547 This will cause @mycorp to be mapped to the registry for future instal‐
1549 lation of packages specified according to the pattern @mycorp/package.
1550 This will also cause npm init to create a scoped package.
1552 # accept all defaults, and create a package named "@foo/whatever",
1554 # instead of just named "whatever"
1555 npm init --scope=@foo --yes
1556 <!-- automatically generated, do not edit manually --> <!-- see
1557 lib/utils/config/definitions.js -->
1558 script-shell
1561 • Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
1562 • Type: null or String
1564 The shell to use for scripts run with the npm exec, npm run and npm
1567 init <pkg> commands. <!-- automatically generated, do not edit manu‐
1568 ally --> <!-- see lib/utils/config/definitions.js -->
1569 searchexclude
1572 • Default: ""
1573 • Type: String
1575 Space-separated options that limit the results from search. <!-- auto‐
1578 matically generated, do not edit manually --> <!-- see lib/utils/con‐
1579 fig/definitions.js -->
1580 searchlimit
1583 • Default: 20
1584 • Type: Number
1586 Number of items to limit search results to. Will not apply at all to
1589 legacy searches. <!-- automatically generated, do not edit manually
1590 --> <!-- see lib/utils/config/definitions.js -->
1591 searchopts
1594 • Default: ""
1595 • Type: String
1597 Space-separated options that are always passed to search. <!-- auto‐
1600 matically generated, do not edit manually --> <!-- see lib/utils/con‐
1601 fig/definitions.js -->
1602 searchstaleness
1605 • Default: 900
1606 • Type: Number
1608 The age of the cache, in seconds, before another registry request is
1611 made if using legacy search endpoint. <!-- automatically generated, do
1612 not edit manually --> <!-- see lib/utils/config/definitions.js -->
1613 shell
1616 • Default: SHELL environment variable, or "bash" on Posix, or "cmd.exe"
1617 on Windows
1618 • Type: String
1620 The shell to run for the npm explore command. <!-- automatically gen‐
1623 erated, do not edit manually --> <!-- see lib/utils/config/defini‐
1624 tions.js -->
1625 sign-git-commit
1628 • Default: false
1629 • Type: Boolean
1631 If set to true, then the npm version command will commit the new pack‐
1634 age version using -S to add a signature.
1635 Note that git requires you to have set up GPG keys in your git configs
1637 for this to work properly. <!-- automatically generated, do not edit
1638 manually --> <!-- see lib/utils/config/definitions.js -->
1639 sign-git-tag
1642 • Default: false
1643 • Type: Boolean
1645 If set to true, then the npm version command will tag the version using
1648 -s to add a signature.
1649 Note that git requires you to have set up GPG keys in your git configs
1651 for this to work properly. <!-- automatically generated, do not edit
1652 manually --> <!-- see lib/utils/config/definitions.js -->
1653 strict-peer-deps
1656 • Default: false
1657 • Type: Boolean
1659 If set to true, and --legacy-peer-deps is not set, then any conflicting
1662 peerDependencies will be treated as an install failure, even if npm
1663 could reasonably guess the appropriate resolution based on non-peer de‐
1664 pendency relationships.
1665 By default, conflicting peerDependencies deep in the dependency graph
1667 will be resolved using the nearest non-peer dependency specification,
1668 even if doing so will result in some packages receiving a peer depen‐
1669 dency outside the range set in their package's peerDependencies object.
1670 When such and override is performed, a warning is printed, explaining
1672 the conflict and the packages involved. If --strict-peer-deps is set,
1673 then this warning is treated as a failure. <!-- automatically gener‐
1674 ated, do not edit manually --> <!-- see lib/utils/config/definitions.js
1675 -->
1676 strict-ssl
1679 • Default: true
1680 • Type: Boolean
1682 Whether or not to do SSL key validation when making requests to the
1685 registry via https.
1686 See also the ca config. <!-- automatically generated, do not edit man‐
1688 ually --> <!-- see lib/utils/config/definitions.js -->
1689 tag
1692 • Default: "latest"
1693 • Type: String
1695 If you ask npm to install a package and don't tell it a specific ver‐
1698 sion, then it will install the specified tag.
1699 Also the tag that is added to the package@version specified by the npm
1701 tag command, if no explicit tag is given.
1702 When used by the npm diff command, this is the tag used to fetch the
1704 tarball that will be compared with the local files by default. <!--
1705 automatically generated, do not edit manually --> <!-- see
1706 lib/utils/config/definitions.js -->
1707 tag-version-prefix
1710 • Default: "v"
1711 • Type: String
1713 If set, alters the prefix used when tagging a new version when perform‐
1716 ing a version increment using npm-version. To remove the prefix alto‐
1717 gether, set it to the empty string: "".
1718 Because other tools may rely on the convention that npm version tags
1720 look like v1.0.0, only use this property if it is absolutely necessary.
1721 In particular, use care when overriding this setting for public pack‐
1722 ages. <!-- automatically generated, do not edit manually --> <!-- see
1723 lib/utils/config/definitions.js -->
1724 timing
1727 • Default: false
1728 • Type: Boolean
1730 If true, writes an npm-debug log to _logs and timing information to
1733 _timing.json, both in your cache, even if the command completes suc‐
1734 cessfully. _timing.json is a newline delimited list of JSON objects.
1735 You can quickly view it with this json https://npm.im/json command
1737 line: npm exec -- json -g < ~/.npm/_timing.json. <!-- automatically
1738 generated, do not edit manually --> <!-- see lib/utils/config/defini‐
1739 tions.js -->
1740 umask
1743 • Default: 0
1744 • Type: Octal numeric string in range 0000..0777 (0..511)
1746 The "umask" value to use when setting the file creation mode on files
1749 and folders.
1750 Folders and executables are given a mode which is 0o777 masked against
1752 this value. Other files are given a mode which is 0o666 masked against
1753 this value.
1754 Note that the underlying system will also apply its own umask value to
1756 files and folders that are created, and npm does not circumvent this,
1757 but rather adds the --umask config to it.
1758 Thus, the effective default umask value on most POSIX systems is 0o22,
1760 meaning that folders and executables are created with a mode of 0o755
1761 and other files are created with a mode of 0o644. <!-- automatically
1762 generated, do not edit manually --> <!-- see lib/utils/config/defini‐
1763 tions.js -->
1764 unicode
1767 • Default: false on windows, true on mac/unix systems with a unicode
1768 locale, as defined by the LC_ALL, LC_CTYPE, or LANG environment vari‐
1769 ables.
1770 • Type: Boolean
1772 When set to true, npm uses unicode characters in the tree output. When
1775 false, it uses ascii characters instead of unicode glyphs. <!-- auto‐
1776 matically generated, do not edit manually --> <!-- see lib/utils/con‐
1777 fig/definitions.js -->
1778 update-notifier
1781 • Default: true
1782 • Type: Boolean
1784 Set to false to suppress the update notification when using an older
1787 version of npm than the latest. <!-- automatically generated, do not
1788 edit manually --> <!-- see lib/utils/config/definitions.js -->
1789 usage
1792 • Default: false
1793 • Type: Boolean
1795 Show short usage output about the command specified. <!-- automati‐
1798 cally generated, do not edit manually --> <!-- see lib/utils/con‐
1799 fig/definitions.js -->
1800 user-agent
1803 • Default: "npm/{npm-version} node/{node-version} {platform} {arch}
1804 workspaces/{workspaces} {ci}"
1805 • Type: String
1807 Sets the User-Agent request header. The following fields are replaced
1810 with their actual counterparts:
1811 • {npm-version} - The npm version in use
1813 • {node-version} - The Node.js version in use
1815 • {platform} - The value of process.platform
1817 • {arch} - The value of process.arch
1819 • {workspaces} - Set to true if the workspaces or workspace options are
1821 set.
1822 • {ci} - The value of the ci-name config, if set, prefixed with ci/, or
1824 an empty string if ci-name is empty.
1825 <!-- automatically generated, do not edit manually --> <!-- see
1827 lib/utils/config/definitions.js -->
1828 userconfig
1831 • Default: "~/.npmrc"
1832 • Type: Path
1834 The location of user-level configuration settings.
1837 This may be overridden by the npm_config_userconfig environment vari‐
1839 able or the --userconfig command line option, but may not be overridden
1840 by settings in the globalconfig file. <!-- automatically generated, do
1841 not edit manually --> <!-- see lib/utils/config/definitions.js -->
1842 version
1845 • Default: false
1846 • Type: Boolean
1848 If true, output the npm version and exit successfully.
1851 Only relevant when specified explicitly on the command line. <!-- au‐
1853 tomatically generated, do not edit manually --> <!-- see lib/utils/con‐
1854 fig/definitions.js -->
1855 versions
1858 • Default: false
1859 • Type: Boolean
1861 If true, output the npm version as well as node's process.versions map
1864 and the version in the current working directory's package.json file if
1865 one exists, and exit successfully.
1866 Only relevant when specified explicitly on the command line. <!-- au‐
1868 tomatically generated, do not edit manually --> <!-- see lib/utils/con‐
1869 fig/definitions.js -->
1870 viewer
1873 • Default: "man" on Posix, "browser" on Windows
1874 • Type: String
1876 The program to use to view help content.
1879 Set to "browser" to view html help content in the default web browser.
1881 <!-- automatically generated, do not edit manually --> <!-- see
1882 lib/utils/config/definitions.js -->
1883 which
1886 • Default: null
1887 • Type: null or Number
1889 If there are multiple funding sources, which 1-indexed source URL to
1892 open. <!-- automatically generated, do not edit manually --> <!-- see
1893 lib/utils/config/definitions.js -->
1894 workspace
1897 • Default:
1898 • Type: String (can be set multiple times)
1900 Enable running a command in the context of the configured workspaces of
1903 the current project while filtering by running only the workspaces de‐
1904 fined by this configuration option.
1905 Valid values for the workspace config are either:
1907 • Workspace names
1909 • Path to a workspace directory
1911 • Path to a parent workspace directory (will result in selecting all
1913 workspaces within that folder)
1914 When set for the npm init command, this may be set to the folder of a
1917 workspace which does not yet exist, to create the folder and set it up
1918 as a brand new workspace within the project.
1919 This value is not exported to the environment for child processes.
1921 <!-- automatically generated, do not edit manually --> <!-- see
1922 lib/utils/config/definitions.js -->
1923 workspaces
1926 • Default: null
1927 • Type: null or Boolean
1929 Set to true to run the command in the context of all configured
1932 workspaces.
1933 Explicitly setting this to false will cause commands like install to
1935 ignore workspaces altogether. When not set explicitly:
1936 • Commands that operate on the node_modules tree (install, update,
1938 etc.) will link workspaces into the node_modules folder. - Commands
1939 that do other things (test, exec, publish, etc.) will operate on the
1940 root project, unless one or more workspaces are specified in the
1941 workspace config.
1942 This value is not exported to the environment for child processes.
1945 <!-- automatically generated, do not edit manually --> <!-- see
1946 lib/utils/config/definitions.js -->
1947 yes
1950 • Default: null
1951 • Type: null or Boolean
1953 Automatically answer "yes" to any prompts that npm might print on the
1956 command line. <!-- automatically generated, do not edit manually -->
1957 <!-- see lib/utils/config/definitions.js -->
1958 also
1961 • Default: null
1962 • Type: null, "dev", or "development"
1964 • DEPRECATED: Please use --include=dev instead.
1966 When set to dev or development, this is an alias for --include=dev.
1969 <!-- automatically generated, do not edit manually --> <!-- see
1970 lib/utils/config/definitions.js -->
1971 auth-type
1974 • Default: "legacy"
1975 • Type: "legacy", "sso", "saml", or "oauth"
1977 • DEPRECATED: This method of SSO/SAML/OAuth is deprecated and will be
1979 removed in a future version of npm in favor of web-based login.
1980 What authentication strategy to use with adduser/login. <!-- automati‐
1983 cally generated, do not edit manually --> <!-- see lib/utils/con‐
1984 fig/definitions.js -->
1985 cache-max
1988 • Default: Infinity
1989 • Type: Number
1991 • DEPRECATED: This option has been deprecated in favor of --prefer-on‐
1993 line
1994 --cache-max=0 is an alias for --prefer-online <!-- automatically gener‐
1997 ated, do not edit manually --> <!-- see lib/utils/config/definitions.js
1998 -->
1999 cache-min
2002 • Default: 0
2003 • Type: Number
2005 • DEPRECATED: This option has been deprecated in favor of --prefer-off‐
2007 line.
2008 --cache-min=9999 (or bigger) is an alias for --prefer-offline. <!--
2011 automatically generated, do not edit manually --> <!-- see
2012 lib/utils/config/definitions.js -->
2013 dev
2016 • Default: false
2017 • Type: Boolean
2019 • DEPRECATED: Please use --include=dev instead.
2021 Alias for --include=dev. <!-- automatically generated, do not edit
2024 manually --> <!-- see lib/utils/config/definitions.js -->
2025 init.author.email
2028 • Default: ""
2029 • Type: String
2031 • DEPRECATED: Use --init-author-email instead.
2033 Alias for --init-author-email <!-- automatically generated, do not edit
2036 manually --> <!-- see lib/utils/config/definitions.js -->
2037 init.author.name
2040 • Default: ""
2041 • Type: String
2043 • DEPRECATED: Use --init-author-name instead.
2045 Alias for --init-author-name <!-- automatically generated, do not edit
2048 manually --> <!-- see lib/utils/config/definitions.js -->
2049 init.author.url
2052 • Default: ""
2053 • Type: "" or URL
2055 • DEPRECATED: Use --init-author-url instead.
2057 Alias for --init-author-url <!-- automatically generated, do not edit
2060 manually --> <!-- see lib/utils/config/definitions.js -->
2061 init.license
2064 • Default: "ISC"
2065 • Type: String
2067 • DEPRECATED: Use --init-license instead.
2069 Alias for --init-license <!-- automatically generated, do not edit man‐
2072 ually --> <!-- see lib/utils/config/definitions.js -->
2073 init.module
2076 • Default: "~/.npm-init.js"
2077 • Type: Path
2079 • DEPRECATED: Use --init-module instead.
2081 Alias for --init-module <!-- automatically generated, do not edit manu‐
2084 ally --> <!-- see lib/utils/config/definitions.js -->
2085 init.version
2088 • Default: "1.0.0"
2089 • Type: SemVer string
2091 • DEPRECATED: Use --init-version instead.
2093 Alias for --init-version <!-- automatically generated, do not edit man‐
2096 ually --> <!-- see lib/utils/config/definitions.js -->
2097 only
2100 • Default: null
2101 • Type: null, "prod", or "production"
2103 • DEPRECATED: Use --omit=dev to omit dev dependencies from the install.
2105 When set to prod or production, this is an alias for --omit=dev. <!--
2108 automatically generated, do not edit manually --> <!-- see
2109 lib/utils/config/definitions.js -->
2110 optional
2113 • Default: null
2114 • Type: null or Boolean
2116 • DEPRECATED: Use --omit=optional to exclude optional dependencies, or
2118 --include=optional to include them.
2119 Default value does install optional deps unless otherwise omitted.
2122 Alias for --include=optional or --omit=optional <!-- automatically gen‐
2124 erated, do not edit manually --> <!-- see lib/utils/config/defini‐
2125 tions.js -->
2126 production
2129 • Default: null
2130 • Type: null or Boolean
2132 • DEPRECATED: Use --omit=dev instead.
2134 Alias for --omit=dev <!-- automatically generated, do not edit manually
2137 --> <!-- see lib/utils/config/definitions.js -->
2138 shrinkwrap
2141 • Default: true
2142 • Type: Boolean
2144 • DEPRECATED: Use the --package-lock setting instead.
2146 Alias for --package-lock <!-- automatically generated, do not edit man‐
2149 ually --> <!-- see lib/utils/config/definitions.js -->
2150 sso-poll-frequency
2153 • Default: 500
2154 • Type: Number
2156 • DEPRECATED: The --auth-type method of SSO/SAML/OAuth will be removed
2158 in a future version of npm in favor of web-based login.
2159 When used with SSO-enabled auth-types, configures how regularly the
2162 registry should be polled while the user is completing authentication.
2163 <!-- automatically generated, do not edit manually --> <!-- see
2164 lib/utils/config/definitions.js -->
2165 sso-type
2168 • Default: "oauth"
2169 • Type: null, "oauth", or "saml"
2171 • DEPRECATED: The --auth-type method of SSO/SAML/OAuth will be removed
2173 in a future version of npm in favor of web-based login.
2174 If --auth-type=sso, the type of SSO type to use. <!-- automatically
2177 generated, do not edit manually --> <!-- see lib/utils/config/defini‐
2178 tions.js -->
2179 tmp
2182 • Default: The value returned by the Node.js os.tmpdir() method
2183 https://nodejs.org/api/os.html#os_os_tmpdir
2184 • Type: Path
2186 • DEPRECATED: This setting is no longer used. npm stores temporary
2188 files in a special location in the cache, and they are managed by ca‐
2189 cache http://npm.im/cacache.
2190 Historically, the location where temporary files were stored. No longer
2193 relevant. <!-- automatically generated, do not edit manually --> <!--
2194 see lib/utils/config/definitions.js --> <!-- AUTOGENERATED CONFIG DE‐
2195 SCRIPTIONS END -->
2196 See also
2199 • npm help config
2200 • npm help npmrc
2202 • npm help scripts
2204 • npm help folders
2206 • npm help npm
2208 January 2022 CONFIG(7)