diff options
Diffstat (limited to 'deps/npm/man/man7/config.7')
| -rw-r--r-- | deps/npm/man/man7/config.7 | 440 |
1 files changed, 439 insertions, 1 deletions
diff --git a/deps/npm/man/man7/config.7 b/deps/npm/man/man7/config.7 index ac0a415f10a..db69e6bb1fd 100644 --- a/deps/npm/man/man7/config.7 +++ b/deps/npm/man/man7/config.7 @@ -1,4 +1,4 @@ -.TH "CONFIG" "7" "July 2021" "" "" +.TH "CONFIG" "7" "August 2021" "" "" .SH "NAME" \fBconfig\fR \- More than you probably want to know about npm configuration .SS Description @@ -58,6 +58,7 @@ internal to npm, and are defaults if nothing else is specified\. The following shorthands are parsed on the command\-line: <!\-\- AUTOGENERATED CONFIG SHORTHANDS START \-\-> <!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> .RS 0 .IP \(bu 2 \fB\-a\fP: \fB\-\-all\fP @@ -139,6 +140,8 @@ The following shorthands are parsed on the command\-line: \fB\-y\fP: \fB\-\-yes\fP .RE +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> <!\-\- AUTOGENERATED CONFIG SHORTHANDS END \-\-> .P @@ -169,6 +172,7 @@ npm ls \-\-global \-\-parseable \-\-long \-\-loglevel info .SS Config Settings <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS START \-\-> <!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> .SS \fB_auth\fP .RS 0 .IP \(bu 2 @@ -183,6 +187,9 @@ A basic\-auth string to use when authenticating against the npm registry\. Warning: This should generally not be set via a command\-line option\. It is safer to use a registry\-provided authentication bearer token stored in the ~/\.npmrc file by running \fBnpm login\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBaccess\fP .RS 0 .IP \(bu 2 @@ -196,6 +203,15 @@ When publishing scoped packages, the access level defaults to \fBrestricted\fP\| If you want your scoped package to be publicly viewable (and installable) set \fB\-\-access=public\fP\|\. The only valid values for \fBaccess\fP are \fBpublic\fP and \fBrestricted\fP\|\. Unscoped packages \fIalways\fR have an access level of \fBpublic\fP\|\. +.P +Note: Using the \fB\-\-access\fP flag on the \fBnpm publish\fP command will only set +the package access level on the initial publish of the package\. Any +subsequent \fBnpm publish\fP commands using the \fB\-\-access\fP flag will not have an +effect to the access level\. To make changes to the access level after the +initial publish use \fBnpm access\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBall\fP .RS 0 .IP \(bu 2 @@ -208,6 +224,9 @@ Type: Boolean When running \fBnpm outdated\fP and \fBnpm ls\fP, setting \fB\-\-all\fP will show all outdated or installed packages, rather than only those directly depended upon by the current project\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBallow\-same\-version\fP .RS 0 .IP \(bu 2 @@ -219,6 +238,9 @@ Type: Boolean .P Prevents throwing an error when \fBnpm version\fP is used to set the new version to the same value as the current version\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBaudit\fP .RS 0 .IP \(bu 2 @@ -232,6 +254,9 @@ When "true" submit audit reports alongside the current npm command to the default registry and all registries configured for scopes\. See the documentation for npm help \fBaudit\fP for details on what is submitted\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBaudit\-level\fP .RS 0 .IP \(bu 2 @@ -243,6 +268,9 @@ Type: null, "info", "low", "moderate", "high", "critical", or "none" .P The minimum level of vulnerability for \fBnpm audit\fP to exit with a non\-zero exit code\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBbefore\fP .RS 0 .IP \(bu 2 @@ -261,6 +289,9 @@ If the requested version is a \fBdist\-tag\fP and the given tag does not pass th \fB\-\-before\fP filter, the most recent version less than or equal to that tag will be used\. For example, \fBfoo@latest\fP might install \fBfoo@1\.2\fP even though \fBlatest\fP is \fB2\.0\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBbin\-links\fP .RS 0 .IP \(bu 2 @@ -276,6 +307,9 @@ executables\. Set to false to have it not do this\. This can be used to work around the fact that some file systems don't support symlinks, even on ostensibly Unix systems\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBbrowser\fP .RS 0 .IP \(bu 2 @@ -291,6 +325,9 @@ Set to \fBfalse\fP to suppress browser behavior and instead print urls to terminal\. .P Set to \fBtrue\fP to use default system URL opener\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBca\fP .RS 0 .IP \(bu 2 @@ -324,6 +361,9 @@ ca[]="\.\.\." .RE .P See also the \fBstrict\-ssl\fP config\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBcache\fP .RS 0 .IP \(bu 2 @@ -335,6 +375,9 @@ Type: Path .P The location of npm's cache directory\. See npm help \fBnpm cache\fP +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBcafile\fP .RS 0 .IP \(bu 2 @@ -347,6 +390,9 @@ Type: Path A path to a file containing one or multiple Certificate Authority signing certificates\. Similar to the \fBca\fP setting, but allows for multiple CA's, as well as for the CA information to be stored in a file on disk\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBcall\fP .RS 0 .IP \(bu 2 @@ -364,6 +410,9 @@ custom command to be run along with the installed packages\. npm exec \-\-package yo \-\-package generator\-node \-\-call "yo node" .fi .RE +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBcert\fP .RS 0 .IP \(bu 2 @@ -385,6 +434,9 @@ cert="\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-\\nXXXX\\nXXXX\\n\-\-\-\-\-END CERTIF .P It is \fInot\fR the path to a certificate file (and there is no "certfile" option)\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBci\-name\fP .RS 0 .IP \(bu 2 @@ -398,6 +450,9 @@ Type: null or String The name of a continuous integration system\. If not set explicitly, npm will detect the current CI environment using the \fB@npmcli/ci\-detect\fP \fIhttp://npm\.im/@npmcli/ci\-detect\fR module\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBcidr\fP .RS 0 .IP \(bu 2 @@ -409,6 +464,9 @@ Type: null or String (can be set multiple times) .P This is a list of CIDR address to be used when configuring limited access tokens with the \fBnpm token create\fP command\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBcolor\fP .RS 0 .IP \(bu 2 @@ -420,6 +478,9 @@ Type: "always" or Boolean .P If false, never shows colors\. If \fB"always"\fP then always shows colors\. If true, then only prints color codes for tty file descriptors\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBcommit\-hooks\fP .RS 0 .IP \(bu 2 @@ -430,6 +491,9 @@ Type: Boolean .RE .P Run git commit hooks when using the \fBnpm version\fP command\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBdepth\fP .RS 0 .IP \(bu 2 @@ -443,6 +507,9 @@ The depth to go when recursing packages for \fBnpm ls\fP\|\. .P If not set, \fBnpm ls\fP will show only the immediate dependencies of the root project\. If \fB\-\-all\fP is set, then npm will show all dependencies by default\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBdescription\fP .RS 0 .IP \(bu 2 @@ -453,6 +520,9 @@ Type: Boolean .RE .P Show the description in \fBnpm search\fP +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBdiff\fP .RS 0 .IP \(bu 2 @@ -463,6 +533,9 @@ Type: String (can be set multiple times) .RE .P Define arguments to compare in \fBnpm diff\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBdiff\-dst\-prefix\fP .RS 0 .IP \(bu 2 @@ -473,6 +546,9 @@ Type: String .RE .P Destination prefix to be used in \fBnpm diff\fP output\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBdiff\-ignore\-all\-space\fP .RS 0 .IP \(bu 2 @@ -483,6 +559,9 @@ Type: Boolean .RE .P Ignore whitespace when comparing lines in \fBnpm diff\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBdiff\-name\-only\fP .RS 0 .IP \(bu 2 @@ -493,6 +572,9 @@ Type: Boolean .RE .P Prints only filenames when using \fBnpm diff\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBdiff\-no\-prefix\fP .RS 0 .IP \(bu 2 @@ -506,6 +588,9 @@ Do not show any source or destination prefix in \fBnpm diff\fP output\. .P Note: this causes \fBnpm diff\fP to ignore the \fB\-\-diff\-src\-prefix\fP and \fB\-\-diff\-dst\-prefix\fP configs\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBdiff\-src\-prefix\fP .RS 0 .IP \(bu 2 @@ -516,6 +601,9 @@ Type: String .RE .P Source prefix to be used in \fBnpm diff\fP output\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBdiff\-text\fP .RS 0 .IP \(bu 2 @@ -526,6 +614,9 @@ Type: Boolean .RE .P Treat all files as text in \fBnpm diff\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBdiff\-unified\fP .RS 0 .IP \(bu 2 @@ -536,6 +627,9 @@ Type: Number .RE .P The number of lines of context to print in \fBnpm diff\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBdry\-run\fP .RS 0 .IP \(bu 2 @@ -552,6 +646,9 @@ commands that modify your local installation, eg, \fBinstall\fP, \fBupdate\fP, .P Note: This is NOT honored by other network related commands, eg \fBdist\-tags\fP, \fBowner\fP, etc\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBeditor\fP .RS 0 .IP \(bu 2 @@ -563,6 +660,9 @@ Type: String .RE .P The command to run for \fBnpm edit\fP and \fBnpm config edit\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBengine\-strict\fP .RS 0 .IP \(bu 2 @@ -577,6 +677,9 @@ installing) any package that claims to not be compatible with the current Node\.js version\. .P This can be overridden by setting the \fB\-\-force\fP flag\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBfetch\-retries\fP .RS 0 .IP \(bu 2 @@ -591,6 +694,9 @@ from the registry\. .P npm will retry idempotent read requests to the registry in the case of network failures or 5xx HTTP errors\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBfetch\-retry\-factor\fP .RS 0 .IP \(bu 2 @@ -601,6 +707,9 @@ Type: Number .RE .P The "factor" config for the \fBretry\fP module to use when fetching packages\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBfetch\-retry\-maxtimeout\fP .RS 0 .IP \(bu 2 @@ -612,6 +721,9 @@ Type: Number .P The "maxTimeout" config for the \fBretry\fP module to use when fetching packages\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBfetch\-retry\-mintimeout\fP .RS 0 .IP \(bu 2 @@ -623,6 +735,9 @@ Type: Number .P The "minTimeout" config for the \fBretry\fP module to use when fetching packages\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBfetch\-timeout\fP .RS 0 .IP \(bu 2 @@ -633,6 +748,9 @@ Type: Number .RE .P The maximum amount of time to wait for HTTP requests to complete\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBforce\fP .RS 0 .IP \(bu 2 @@ -673,6 +791,9 @@ Allow clobbering existing values in \fBnpm pkg\fP .P If you don't have a clear idea of what you want to do, it is strongly recommended that you do not use this option! +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBforeground\-scripts\fP .RS 0 .IP \(bu 2 @@ -688,6 +809,9 @@ input, output, and error with the main npm process\. .P Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBformat\-package\-lock\fP .RS 0 .IP \(bu 2 @@ -699,6 +823,9 @@ Type: Boolean .P Format \fBpackage\-lock\.json\fP or \fBnpm\-shrinkwrap\.json\fP as a human readable file\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBfund\fP .RS 0 .IP \(bu 2 @@ -711,6 +838,9 @@ Type: Boolean When "true" displays the message at the end of each \fBnpm install\fP acknowledging the number of dependencies looking for funding\. See npm help \fBnpm fund\fP for details\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBgit\fP .RS 0 .IP \(bu 2 @@ -722,6 +852,9 @@ Type: String .P The command to use for git commands\. If git is installed on the computer, but is not in the \fBPATH\fP, then set this to the full path to the git binary\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBgit\-tag\-version\fP .RS 0 .IP \(bu 2 @@ -732,6 +865,9 @@ Type: Boolean .RE .P Tag the commit when using the \fBnpm version\fP command\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBglobal\fP .RS 0 .IP \(bu 2 @@ -754,6 +890,9 @@ bin files are linked to \fB{prefix}/bin\fP man pages are linked to \fB{prefix}/share/man\fP .RE +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBglobal\-style\fP .RS 0 .IP \(bu 2 @@ -769,6 +908,9 @@ direct dependencies will show in \fBnode_modules\fP and everything they depend on will be flattened in their \fBnode_modules\fP folders\. This obviously will eliminate some deduping\. If used with \fBlegacy\-bundling\fP, \fBlegacy\-bundling\fP will be preferred\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBglobalconfig\fP .RS 0 .IP \(bu 2 @@ -780,6 +922,9 @@ Type: Path .RE .P The config file to read for global config options\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBheading\fP .RS 0 .IP \(bu 2 @@ -790,6 +935,9 @@ Type: String .RE .P The string that starts all the debugging log output\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBhttps\-proxy\fP .RS 0 .IP \(bu 2 @@ -803,6 +951,9 @@ A proxy to use for outgoing https requests\. If the \fBHTTPS_PROXY\fP or \fBhttps_proxy\fP or \fBHTTP_PROXY\fP or \fBhttp_proxy\fP environment variables are set, proxy settings will be honored by the underlying \fBmake\-fetch\-happen\fP library\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBif\-present\fP .RS 0 .IP \(bu 2 @@ -818,6 +969,9 @@ This option can be used when it's desirable to optionally run a script when it's present and fail if the script fails\. This is useful, for example, when running scripts that may only apply for some builds in an otherwise generic CI setup\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBignore\-scripts\fP .RS 0 .IP \(bu 2 @@ -833,6 +987,9 @@ Note that commands explicitly intended to run a particular script, such as \fBnpm start\fP, \fBnpm stop\fP, \fBnpm restart\fP, \fBnpm test\fP, and \fBnpm run\-script\fP will still run their intended script if \fBignore\-scripts\fP is set, but they will \fInot\fR run any pre\- or post\-scripts\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBinclude\fP .RS 0 .IP \(bu 2 @@ -848,6 +1005,9 @@ This is the inverse of \fB\-\-omit=<type>\fP\|\. .P Dependency types specified in \fB\-\-include\fP will not be omitted, regardless of the order in which omit/include are specified on the command\-line\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBinclude\-staged\fP .RS 0 .IP \(bu 2 @@ -861,6 +1021,9 @@ Allow installing "staged" published packages, as defined by npm RFC PR #92 \fIhttps://github\.com/npm/rfcs/pull/92\fR\|\. .P This is experimental, and not implemented by the npm public registry\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBinit\-author\-email\fP .RS 0 .IP \(bu 2 @@ -871,6 +1034,9 @@ Type: String .RE .P The value \fBnpm init\fP should use by default for the package author's email\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBinit\-author\-name\fP .RS 0 .IP \(bu 2 @@ -881,6 +1047,9 @@ Type: String .RE .P The value \fBnpm init\fP should use by default for the package author's name\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBinit\-author\-url\fP .RS 0 .IP \(bu 2 @@ -892,6 +1061,9 @@ Type: "" or URL .P The value \fBnpm init\fP should use by default for the package author's homepage\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBinit\-license\fP .RS 0 .IP \(bu 2 @@ -902,6 +1074,9 @@ Type: String .RE .P The value \fBnpm init\fP should use by default for the package license\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBinit\-module\fP .RS 0 .IP \(bu 2 @@ -915,6 +1090,9 @@ A module that will be loaded by the \fBnpm init\fP command\. See the documentation for the init\-package\-json \fIhttps://github\.com/npm/init\-package\-json\fR module for more information, or npm help init\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBinit\-version\fP .RS 0 .IP \(bu 2 @@ -926,6 +1104,9 @@ Type: SemVer string .P The value that \fBnpm init\fP should use by default for the package version number, if not already set in package\.json\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBjson\fP .RS 0 .IP \(bu 2 @@ -944,6 +1125,9 @@ saving them to your \fBpackage\.json\fP\|\. .RE .P Not supported by all npm commands\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBkey\fP .RS 0 .IP \(bu 2 @@ -963,6 +1147,9 @@ key="\-\-\-\-\-BEGIN PRIVATE KEY\-\-\-\-\-\\nXXXX\\nXXXX\\n\-\-\-\-\-END PRIVATE .RE .P It is \fInot\fR the path to a key file (and there is no "keyfile" option)\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBlegacy\-bundling\fP .RS 0 .IP \(bu 2 @@ -976,6 +1163,9 @@ Causes npm to install the package such that versions of npm prior to 1\.4, such as the one included with node 0\.8, can install the package\. This eliminates all automatic deduping\. If used with \fBglobal\-style\fP this option will be preferred\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBlegacy\-peer\-deps\fP .RS 0 .IP \(bu 2 @@ -997,6 +1187,9 @@ This differs from \fB\-\-omit=peer\fP, in that \fB\-\-omit=peer\fP will avoid un .P Use of \fBlegacy\-peer\-deps\fP is not recommended, as it will not enforce the \fBpeerDependencies\fP contract that meta\-dependencies may rely on\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBlink\fP .RS 0 .IP \(bu 2 @@ -1007,6 +1200,9 @@ Type: Boolean .RE .P Used with \fBnpm ls\fP, limiting output to only those packages that are linked\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBlocal\-address\fP .RS 0 .IP \(bu 2 @@ -1018,6 +1214,9 @@ Type: IP Address .P The IP address of the local interface to use when making connections to the npm registry\. Must be IPv4 in versions of Node prior to 0\.12\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBlocation\fP .RS 0 .IP \(bu 2 @@ -1029,6 +1228,9 @@ Type: "global", "user", or "project" .RE .P When passed to \fBnpm config\fP this refers to which config file to use\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBloglevel\fP .RS 0 .IP \(bu 2 @@ -1046,6 +1248,9 @@ Any logs of a higher level than the setting are shown\. The default is "notice"\. .P See also the \fBforeground\-scripts\fP config\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBlogs\-max\fP .RS 0 .IP \(bu 2 @@ -1056,6 +1261,9 @@ Type: Number .RE .P The maximum number of log files to store\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBlong\fP .RS 0 .IP \(bu 2 @@ -1066,6 +1274,9 @@ Type: Boolean .RE .P Show extended information in \fBls\fP, \fBsearch\fP, and \fBhelp\-search\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBmaxsockets\fP .RS 0 .IP \(bu 2 @@ -1077,6 +1288,9 @@ Type: Number .P The maximum number of connections to use per origin (protocol/host/port combination)\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBmessage\fP .RS 0 .IP \(bu 2 @@ -1089,6 +1303,9 @@ Type: String Commit message which is used by \fBnpm version\fP when creating version commit\. .P Any "%s" in the message will be replaced with the version number\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBnode\-options\fP .RS 0 .IP \(bu 2 @@ -1101,6 +1318,9 @@ Type: null or String Options to pass through to Node\.js via the \fBNODE_OPTIONS\fP environment variable\. This does not impact how npm itself is executed but it does impact how lifecycle scripts are called\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBnode\-version\fP .RS 0 .IP \(bu 2 @@ -1111,6 +1331,9 @@ Type: SemVer string .RE .P The node version to use when checking a package's \fBengines\fP setting\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBnoproxy\fP .RS 0 .IP \(bu 2 @@ -1123,6 +1346,9 @@ Type: String (can be set multiple times) Domain extensions that should bypass any proxies\. .P Also accepts a comma\-delimited string\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBnpm\-version\fP .RS 0 .IP \(bu 2 @@ -1133,6 +1359,9 @@ Type: SemVer string .RE .P The npm version to use when checking a package's \fBengines\fP setting\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBoffline\fP .RS 0 .IP \(bu 2 @@ -1144,6 +1373,9 @@ Type: Boolean .P Force offline mode: no network requests will be done during install\. To allow the CLI to fill in missing cache data, see \fB\-\-prefer\-offline\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBomit\fP .RS 0 .IP \(bu 2 @@ -1165,6 +1397,9 @@ it will be included\. .P If the resulting omit list includes \fB\|'dev'\fP, then the \fBNODE_ENV\fP environment variable will be set to \fB\|'production'\fP for all lifecycle scripts\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBotp\fP .RS 0 .IP \(bu 2 @@ -1179,6 +1414,9 @@ when publishing or changing package permissions with \fBnpm access\fP\|\. .P If not set, and a registry response fails with a challenge for a one\-time password, npm will prompt on the command line for one\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBpack\-destination\fP .RS 0 .IP \(bu 2 @@ -1189,6 +1427,9 @@ Type: String .RE .P Directory in which \fBnpm pack\fP will save tarballs\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBpackage\fP .RS 0 .IP \(bu 2 @@ -1199,6 +1440,9 @@ Type: String (can be set multiple times) .RE .P The package to install for npm help \fBexec\fP +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBpackage\-lock\fP .RS 0 .IP \(bu 2 @@ -1214,6 +1458,9 @@ will also prevent \fIwriting\fR \fBpackage\-lock\.json\fP if \fBsave\fP is true\ When package package\-locks are disabled, automatic pruning of extraneous modules will also be disabled\. To remove extraneous modules with package\-locks disabled use \fBnpm prune\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBpackage\-lock\-only\fP .RS 0 .IP \(bu 2 @@ -1231,6 +1478,9 @@ instead of checking \fBnode_modules\fP and downloading dependencies\. .P For \fBlist\fP this means the output will be based on the tree described by the \fBpackage\-lock\.json\fP, rather than the contents of \fBnode_modules\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBparseable\fP .RS 0 .IP \(bu 2 @@ -1242,6 +1492,9 @@ Type: Boolean .P Output parseable results from commands that write to standard output\. For \fBnpm search\fP, this will be tab\-separated table format\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBprefer\-offline\fP .RS 0 .IP \(bu 2 @@ -1254,6 +1507,9 @@ Type: Boolean If true, staleness checks for cached data will be bypassed, but missing data will be requested from the server\. To force full offline mode, use \fB\-\-offline\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBprefer\-online\fP .RS 0 .IP \(bu 2 @@ -1265,6 +1521,9 @@ Type: Boolean .P If true, staleness checks for cached data will be forced, making the CLI look for updates immediately even for fresh package data\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBprefix\fP .RS 0 .IP \(bu 2 @@ -1278,6 +1537,9 @@ Type: Path .P The location to install global items\. If set on the command line, then it forces non\-global commands to run in the specified folder\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBpreid\fP .RS 0 .IP \(bu 2 @@ -1289,6 +1551,9 @@ Type: String .P The "prerelease identifier" to use as a prefix for the "prerelease" part of a semver\. Like the \fBrc\fP in \fB1\.2\.0\-rc\.8\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBprogress\fP .RS 0 .IP \(bu 2 @@ -1302,6 +1567,9 @@ When set to \fBtrue\fP, npm will display a progress bar during time intensive operations, if \fBprocess\.stderr\fP is a TTY\. .P Set to \fBfalse\fP to suppress the progress bar\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBproxy\fP .RS 0 .IP \(bu 2 @@ -1314,6 +1582,9 @@ Type: null, false, or URL A proxy to use for outgoing http requests\. If the \fBHTTP_PROXY\fP or \fBhttp_proxy\fP environment variables are set, proxy settings will be honored by the underlying \fBrequest\fP library\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBread\-only\fP .RS 0 .IP \(bu 2 @@ -1325,6 +1596,9 @@ Type: Boolean .P This is used to mark a token as unable to publish when configuring limited access tokens with the \fBnpm token create\fP command\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBrebuild\-bundle\fP .RS 0 .IP \(bu 2 @@ -1335,6 +1609,9 @@ Type: Boolean .RE .P Rebuild bundled dependencies after installation\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBregistry\fP .RS 0 .IP \(bu 2 @@ -1345,6 +1622,9 @@ Type: URL .RE .P The base URL of the npm registry\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBsave\fP .RS 0 .IP \(bu 2 @@ -1358,6 +1638,9 @@ Save installed packages to a package\.json file as dependencies\. .P When used with the \fBnpm rm\fP command, removes the dependency from package\.json\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBsave\-bundle\fP .RS 0 .IP \(bu 2 @@ -1372,6 +1655,9 @@ If a package would be saved at install time by the use of \fB\-\-save\fP, \fBbundleDependencies\fP list\. .P Ignore if \fB\-\-save\-peer\fP is set, since peerDependencies cannot be bundled\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBsave\-dev\fP .RS 0 .IP \(bu 2 @@ -1382,6 +1668,9 @@ Type: Boolean .RE .P Save installed packages to a package\.json file as \fBdevDependencies\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBsave\-exact\fP .RS 0 .IP \(bu 2 @@ -1393,6 +1682,9 @@ Type: Boolean .P Dependencies saved to package\.json will be configured with an exact version rather than using npm's default semver range operator\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBsave\-optional\fP .RS 0 .IP \(bu 2 @@ -1403,6 +1695,9 @@ Type: Boolean .RE .P Save installed packages to a package\.json file as \fBoptionalDependencies\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBsave\-peer\fP .RS 0 .IP \(bu 2 @@ -1413,6 +1708,9 @@ Type: Boolean .RE .P Save installed packages\. to a package\.json file as \fBpeerDependencies\fP +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBsave\-prefix\fP .RS 0 .IP \(bu 2 @@ -1429,6 +1727,9 @@ For example if a package has version \fB1\.2\.3\fP, by default its version is se to \fB^1\.2\.3\fP which allows minor upgrades for that package, but after \fBnpm config set save\-prefix='~'\fP it would be set to \fB~1\.2\.3\fP which only allows patch upgrades\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBsave\-prod\fP .RS 0 .IP \(bu 2 @@ -1444,6 +1745,9 @@ you want to move it to be a non\-optional production dependency\. .P This is the default behavior if \fB\-\-save\fP is true, and neither \fB\-\-save\-dev\fP or \fB\-\-save\-optional\fP are true\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBscope\fP .RS 0 .IP \(bu 2 @@ -1480,6 +1784,9 @@ This will also cause \fBnpm init\fP to create a scoped package\. npm init \-\-scope=@foo \-\-yes .fi .RE +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBscript\-shell\fP .RS 0 .IP \(bu 2 @@ -1491,6 +1798,9 @@ Type: null or String .P The shell to use for scripts run with the \fBnpm exec\fP, \fBnpm run\fP and \fBnpm init <pkg>\fP commands\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBsearchexclude\fP .RS 0 .IP \(bu 2 @@ -1501,6 +1811,9 @@ Type: String .RE .P Space\-separated options that limit the results from search\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBsearchlimit\fP .RS 0 .IP \(bu 2 @@ -1512,6 +1825,9 @@ Type: Number .P Number of items to limit search results to\. Will not apply at all to legacy searches\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBsearchopts\fP .RS 0 .IP \(bu 2 @@ -1522,6 +1838,9 @@ Type: String .RE .P Space\-separated options that are always passed to search\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBsearchstaleness\fP .RS 0 .IP \(bu 2 @@ -1533,6 +1852,9 @@ Type: Number .P The age of the cache, in seconds, before another registry request is made if using legacy search endpoint\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBshell\fP .RS 0 .IP \(bu 2 @@ -1544,6 +1866,9 @@ Type: String .RE .P The shell to run for the \fBnpm explore\fP command\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBsign\-git\-commit\fP .RS 0 .IP \(bu 2 @@ -1558,6 +1883,9 @@ version using \fB\-S\fP to add a signature\. .P Note that git requires you to have set up GPG keys in your git configs for this to work properly\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBsign\-git\-tag\fP .RS 0 .IP \(bu 2 @@ -1572,6 +1900,9 @@ If set to true, then the \fBnpm version\fP command will tag the version using .P Note that git requires you to have set up GPG keys in your git configs for this to work properly\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBstrict\-peer\-deps\fP .RS 0 .IP \(bu 2 @@ -1594,6 +1925,9 @@ the range set in their package's \fBpeerDependencies\fP object\. When such and override is performed, a warning is printed, explaining the conflict and the packages involved\. If \fB\-\-strict\-peer\-deps\fP is set, then this warning is treated as a failure\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBstrict\-ssl\fP .RS 0 .IP \(bu 2 @@ -1607,6 +1941,9 @@ Whether or not to do SSL key validation when making requests to the registry via https\. .P See also the \fBca\fP config\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBtag\fP .RS 0 .IP \(bu 2 @@ -1624,6 +1961,9 @@ command, if no explicit tag is given\. .P When used by the \fBnpm diff\fP command, this is the tag used to fetch the tarball that will be compared with the local files by default\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBtag\-version\-prefix\fP .RS 0 .IP \(bu 2 @@ -1640,6 +1980,9 @@ it to the empty string: \fB""\fP\|\. Because other tools may rely on the convention that npm version tags look like \fBv1\.0\.0\fP, \fIonly use this property if it is absolutely necessary\fR\|\. In particular, use care when overriding this setting for public packages\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBtiming\fP .RS 0 .IP \(bu 2 @@ -1655,6 +1998,9 @@ successfully\. \fB_timing\.json\fP is a newline delimited list of JSON objects\. .P You can quickly view it with this json \fIhttps://npm\.im/json\fR command line: \fBnpm exec \-\- json \-g < ~/\.npm/_timing\.json\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBumask\fP .RS 0 .IP \(bu 2 @@ -1678,6 +2024,9 @@ rather adds the \fB\-\-umask\fP config to it\. Thus, the effective default umask value on most POSIX systems is 0o22, meaning that folders and executables are created with a mode of 0o755 and other files are created with a mode of 0o644\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBunicode\fP .RS 0 .IP \(bu 2 @@ -1690,6 +2039,9 @@ Type: Boolean .P When set to true, npm uses unicode characters in the tree output\. When false, it uses ascii characters instead of unicode glyphs\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBupdate\-notifier\fP .RS 0 .IP \(bu 2 @@ -1701,6 +2053,9 @@ Type: Boolean .P Set to false to suppress the update notification when using an older version of npm than the latest\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBusage\fP .RS 0 .IP \(bu 2 @@ -1711,6 +2066,9 @@ Type: Boolean .RE .P Show short usage output about the command specified\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBuser\-agent\fP .RS 0 .IP \(bu 2 @@ -1740,6 +2098,9 @@ are set\. an empty string if \fBci\-name\fP is empty\. .RE +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBuserconfig\fP .RS 0 .IP \(bu 2 @@ -1754,6 +2115,9 @@ The location of user\-level configuration settings\. This may be overridden by the \fBnpm_config_userconfig\fP environment variable or the \fB\-\-userconfig\fP command line option, but may \fInot\fR be overridden by settings in the \fBglobalconfig\fP file\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBversion\fP .RS 0 .IP \(bu 2 @@ -1766,6 +2130,9 @@ Type: Boolean If true, output the npm version and exit successfully\. .P Only relevant when specified explicitly on the command line\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBversions\fP .RS 0 .IP \(bu 2 @@ -1780,6 +2147,9 @@ the version in the current working directory's \fBpackage\.json\fP file if one exists, and exit successfully\. .P Only relevant when specified explicitly on the command line\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBviewer\fP .RS 0 .IP \(bu 2 @@ -1792,6 +2162,9 @@ Type: String The program to use to view help content\. .P Set to \fB"browser"\fP to view html help content in the default web browser\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBwhich\fP .RS 0 .IP \(bu 2 @@ -1802,6 +2175,9 @@ Type: null or Number .RE .P If there are multiple funding sources, which 1\-indexed source URL to open\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBworkspace\fP .RS 0 .IP \(bu 2 @@ -1832,6 +2208,9 @@ workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project\. .P This value is not exported to the environment for child processes\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBworkspaces\fP .RS 0 .IP \(bu 2 @@ -1845,6 +2224,9 @@ Enable running a command in the context of \fBall\fR the configured workspaces\. .P This value is not exported to the environment for child processes\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fByes\fP .RS 0 .IP \(bu 2 @@ -1856,6 +2238,9 @@ Type: null or Boolean .P Automatically answer "yes" to any prompts that npm might print on the command line\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBalso\fP .RS 0 .IP \(bu 2 @@ -1868,6 +2253,9 @@ DEPRECATED: Please use \-\-include=dev instead\. .RE .P When set to \fBdev\fP or \fBdevelopment\fP, this is an alias for \fB\-\-include=dev\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBauth\-type\fP .RS 0 .IP \(bu 2 @@ -1881,6 +2269,9 @@ in a future version of npm in favor of web\-based login\. .RE .P What authentication strategy to use with \fBadduser\fP/\fBlogin\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBcache\-max\fP .RS 0 .IP \(bu 2 @@ -1893,6 +2284,9 @@ DEPRECATED: This option has been deprecated in favor of \fB\-\-prefer\-online\fP .RE .P \fB\-\-cache\-max=0\fP is an alias for \fB\-\-prefer\-online\fP +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBcache\-min\fP .RS 0 .IP \(bu 2 @@ -1905,6 +2299,9 @@ DEPRECATED: This option has been deprecated in favor of \fB\-\-prefer\-offline\f .RE .P \fB\-\-cache\-min=9999 (or bigger)\fP is an alias for \fB\-\-prefer\-offline\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBdev\fP .RS 0 .IP \(bu 2 @@ -1917,6 +2314,9 @@ DEPRECATED: Please use \-\-include=dev instead\. .RE .P Alias for \fB\-\-include=dev\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBinit\.author\.email\fP .RS 0 .IP \(bu 2 @@ -1929,6 +2329,9 @@ DEPRECATED: Use \fB\-\-init\-author\-email\fP instead\. .RE .P Alias for \fB\-\-init\-author\-email\fP +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBinit\.author\.name\fP .RS 0 .IP \(bu 2 @@ -1941,6 +2344,9 @@ DEPRECATED: Use \fB\-\-init\-author\-name\fP instead\. .RE .P Alias for \fB\-\-init\-author\-name\fP +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBinit\.author\.url\fP .RS 0 .IP \(bu 2 @@ -1953,6 +2359,9 @@ DEPRECATED: Use \fB\-\-init\-author\-url\fP instead\. .RE .P Alias for \fB\-\-init\-author\-url\fP +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBinit\.license\fP .RS 0 .IP \(bu 2 @@ -1965,6 +2374,9 @@ DEPRECATED: Use \fB\-\-init\-license\fP instead\. .RE .P Alias for \fB\-\-init\-license\fP +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBinit\.module\fP .RS 0 .IP \(bu 2 @@ -1977,6 +2389,9 @@ DEPRECATED: Use \fB\-\-init\-module\fP instead\. .RE .P Alias for \fB\-\-init\-module\fP +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBinit\.version\fP .RS 0 .IP \(bu 2 @@ -1989,6 +2404,9 @@ DEPRECATED: Use \fB\-\-init\-version\fP instead\. .RE .P Alias for \fB\-\-init\-version\fP +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBonly\fP .RS 0 .IP \(bu 2 @@ -2001,6 +2419,9 @@ DEPRECATED: Use \fB\-\-omit=dev\fP to omit dev dependencies from the install\. .RE .P When set to \fBprod\fP or \fBproduction\fP, this is an alias for \fB\-\-omit=dev\fP\|\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBoptional\fP .RS 0 .IP \(bu 2 @@ -2016,6 +2437,9 @@ DEPRECATED: Use \fB\-\-omit=optional\fP to exclude optional dependencies, or Default value does install optional deps unless otherwise omitted\. .P Alias for \-\-include=optional or \-\-omit=optional +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBproduction\fP .RS 0 .IP \(bu 2 @@ -2028,6 +2452,9 @@ DEPRECATED: Use \fB\-\-omit=dev\fP instead\. .RE .P Alias for \fB\-\-omit=dev\fP +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBshrinkwrap\fP .RS 0 .IP \(bu 2 @@ -2040,6 +2467,9 @@ DEPRECATED: Use the \-\-package\-lock setting instead\. .RE .P Alias for \-\-package\-lock +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBsso\-poll\-frequency\fP .RS 0 .IP \(bu 2 @@ -2054,6 +2484,9 @@ future version of npm in favor of web\-based login\. .P When used with SSO\-enabled \fBauth\-type\fPs, configures how regularly the registry should be polled while the user is completing authentication\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBsso\-type\fP .RS 0 .IP \(bu 2 @@ -2067,6 +2500,9 @@ future version of npm in favor of web\-based login\. .RE .P If \fB\-\-auth\-type=sso\fP, the type of SSO type to use\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> + .SS \fBtmp\fP .RS 0 .IP \(bu 2 @@ -2083,6 +2519,8 @@ special location in the cache, and they are managed by .P Historically, the location where temporary files were stored\. No longer relevant\. +<!\-\- automatically generated, do not edit manually \-\-> +<!\-\- see lib/utils/config/definitions\.js \-\-> <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS END \-\-> .SS See also |