diff options
Diffstat (limited to 'deps/npm/docs/content/using-npm/config.md')
| -rw-r--r-- | deps/npm/docs/content/using-npm/config.md | 438 |
1 files changed, 438 insertions, 0 deletions
diff --git a/deps/npm/docs/content/using-npm/config.md b/deps/npm/docs/content/using-npm/config.md index c4d1afed35c..10e8ca9b9dc 100644 --- a/deps/npm/docs/content/using-npm/config.md +++ b/deps/npm/docs/content/using-npm/config.md @@ -61,6 +61,7 @@ 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 --> * `-a`: `--all` * `--enjoy-by`: `--before` * `-c`: `--call` @@ -101,6 +102,8 @@ The following shorthands are parsed on the command-line: * `--ws`: `--workspaces` * `-y`: `--yes` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> <!-- AUTOGENERATED CONFIG SHORTHANDS END --> If the specified configuration param resolves unambiguously to a known @@ -128,6 +131,7 @@ npm ls --global --parseable --long --loglevel info <!-- AUTOGENERATED CONFIG DESCRIPTIONS START --> <!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> #### `_auth` * Default: null @@ -139,6 +143,9 @@ 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 `npm login`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `access` * Default: 'restricted' for scoped packages, 'public' for unscoped packages @@ -149,6 +156,15 @@ If you want your scoped package to be publicly viewable (and installable) set `--access=public`. The only valid values for `access` are `public` and `restricted`. Unscoped packages _always_ have an access level of `public`. +Note: Using the `--access` flag on the `npm publish` command will only set +the package access level on the initial publish of the package. Any +subsequent `npm publish` commands using the `--access` flag will not have an +effect to the access level. To make changes to the access level after the +initial publish use `npm access`. + +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `all` * Default: false @@ -158,6 +174,9 @@ When running `npm outdated` and `npm ls`, setting `--all` 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 --> + #### `allow-same-version` * Default: false @@ -166,6 +185,9 @@ upon by the current project. Prevents throwing an error when `npm version` 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 --> + #### `audit` * Default: true @@ -176,6 +198,9 @@ default registry and all registries configured for scopes. See the documentation for [`npm audit`](/commands/npm-audit) for details on what is submitted. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `audit-level` * Default: null @@ -184,6 +209,9 @@ submitted. The minimum level of vulnerability for `npm audit` to exit with a non-zero exit code. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `before` * Default: null @@ -199,6 +227,9 @@ If the requested version is a `dist-tag` and the given tag does not pass the will be used. For example, `foo@latest` might install `foo@1.2` even though `latest` is `2.0`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `bin-links` * Default: true @@ -211,6 +242,9 @@ 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 --> + #### `browser` * Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"` @@ -223,6 +257,9 @@ terminal. Set to `true` to use default system URL opener. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `ca` * Default: null @@ -249,6 +286,9 @@ ca[]="..." See also the `strict-ssl` config. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `cache` * Default: Windows: `%LocalAppData%\npm-cache`, Posix: `~/.npm` @@ -257,6 +297,9 @@ See also the `strict-ssl` config. The location of npm's cache directory. See [`npm cache`](/commands/npm-cache) +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `cafile` * Default: null @@ -266,6 +309,9 @@ A path to a file containing one or multiple Certificate Authority signing certificates. Similar to the `ca` 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 --> + #### `call` * Default: "" @@ -279,6 +325,9 @@ npm exec --package yo --package generator-node --call "yo node" ``` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `cert` * Default: null @@ -295,6 +344,9 @@ cert="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----" It is _not_ the path to a certificate file (and there is no "certfile" option). +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `ci-name` * Default: The name of the current CI system, or `null` when not on a known CI @@ -305,6 +357,9 @@ The name of a continuous integration system. If not set explicitly, npm will detect the current CI environment using the [`@npmcli/ci-detect`](http://npm.im/@npmcli/ci-detect) module. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `cidr` * Default: null @@ -313,6 +368,9 @@ detect the current CI environment using the This is a list of CIDR address to be used when configuring limited access tokens with the `npm token create` command. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `color` * Default: true unless the NO_COLOR environ is set to something other than '0' @@ -321,6 +379,9 @@ tokens with the `npm token create` command. If false, never shows colors. If `"always"` 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 --> + #### `commit-hooks` * Default: true @@ -328,6 +389,9 @@ true, then only prints color codes for tty file descriptors. Run git commit hooks when using the `npm version` command. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `depth` * Default: `Infinity` if `--all` is set, otherwise `1` @@ -338,6 +402,9 @@ The depth to go when recursing packages for `npm ls`. If not set, `npm ls` will show only the immediate dependencies of the root project. If `--all` is set, then npm will show all dependencies by default. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `description` * Default: true @@ -345,6 +412,9 @@ project. If `--all` is set, then npm will show all dependencies by default. Show the description in `npm search` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff` * Default: @@ -352,6 +422,9 @@ Show the description in `npm search` Define arguments to compare in `npm diff`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-dst-prefix` * Default: "b/" @@ -359,6 +432,9 @@ Define arguments to compare in `npm diff`. Destination prefix to be used in `npm diff` output. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-ignore-all-space` * Default: false @@ -366,6 +442,9 @@ Destination prefix to be used in `npm diff` output. Ignore whitespace when comparing lines in `npm diff`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-name-only` * Default: false @@ -373,6 +452,9 @@ Ignore whitespace when comparing lines in `npm diff`. Prints only filenames when using `npm diff`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-no-prefix` * Default: false @@ -383,6 +465,9 @@ Do not show any source or destination prefix in `npm diff` output. Note: this causes `npm diff` to ignore the `--diff-src-prefix` and `--diff-dst-prefix` configs. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-src-prefix` * Default: "a/" @@ -390,6 +475,9 @@ Note: this causes `npm diff` to ignore the `--diff-src-prefix` and Source prefix to be used in `npm diff` output. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-text` * Default: false @@ -397,6 +485,9 @@ Source prefix to be used in `npm diff` output. Treat all files as text in `npm diff`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `diff-unified` * Default: 3 @@ -404,6 +495,9 @@ Treat all files as text in `npm diff`. The number of lines of context to print in `npm diff`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `dry-run` * Default: false @@ -417,6 +511,9 @@ commands that modify your local installation, eg, `install`, `update`, Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `editor` * Default: The EDITOR or VISUAL environment variables, or 'notepad.exe' on @@ -425,6 +522,9 @@ Note: This is NOT honored by other network related commands, eg `dist-tags`, The command to run for `npm edit` and `npm config edit`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `engine-strict` * Default: false @@ -436,6 +536,9 @@ Node.js version. This can be overridden by setting the `--force` flag. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `fetch-retries` * Default: 2 @@ -447,6 +550,9 @@ from the registry. 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 --> + #### `fetch-retry-factor` * Default: 10 @@ -454,6 +560,9 @@ network failures or 5xx HTTP errors. The "factor" config for the `retry` module to use when fetching packages. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `fetch-retry-maxtimeout` * Default: 60000 (1 minute) @@ -462,6 +571,9 @@ The "factor" config for the `retry` module to use when fetching packages. The "maxTimeout" config for the `retry` module to use when fetching packages. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `fetch-retry-mintimeout` * Default: 10000 (10 seconds) @@ -470,6 +582,9 @@ packages. The "minTimeout" config for the `retry` module to use when fetching packages. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `fetch-timeout` * Default: 300000 (5 minutes) @@ -477,6 +592,9 @@ packages. The maximum amount of time to wait for HTTP requests to complete. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `force` * Default: false @@ -502,6 +620,9 @@ mistakes, unnecessary performance degradation, and malicious input. 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 --> + #### `foreground-scripts` * Default: false @@ -514,6 +635,9 @@ input, output, and error with the main npm process. 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 --> + #### `format-package-lock` * Default: true @@ -522,6 +646,9 @@ but can be useful for debugging. Format `package-lock.json` or `npm-shrinkwrap.json` as a human readable file. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `fund` * Default: true @@ -531,6 +658,9 @@ When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/commands/npm-fund) for details. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `git` * Default: "git" @@ -539,6 +669,9 @@ fund`](/commands/npm-fund) for details. The command to use for git commands. If git is installed on the computer, but is not in the `PATH`, then set this to the full path to the git binary. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `git-tag-version` * Default: true @@ -546,6 +679,9 @@ but is not in the `PATH`, then set this to the full path to the git binary. Tag the commit when using the `npm version` command. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `global` * Default: false @@ -560,6 +696,9 @@ folder instead of the current working directory. See * bin files are linked to `{prefix}/bin` * man pages are linked to `{prefix}/share/man` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `global-style` * Default: false @@ -572,6 +711,9 @@ on will be flattened in their `node_modules` folders. This obviously will eliminate some deduping. If used with `legacy-bundling`, `legacy-bundling` will be preferred. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `globalconfig` * Default: The global --prefix setting plus 'etc/npmrc'. For example, @@ -580,6 +722,9 @@ will be preferred. The config file to read for global config options. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `heading` * Default: "npm" @@ -587,6 +732,9 @@ The config file to read for global config options. The string that starts all the debugging log output. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `https-proxy` * Default: null @@ -597,6 +745,9 @@ A proxy to use for outgoing https requests. If the `HTTPS_PROXY` or proxy settings will be honored by the underlying `make-fetch-happen` library. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `if-present` * Default: false @@ -609,6 +760,9 @@ 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 --> + #### `ignore-scripts` * Default: false @@ -621,6 +775,9 @@ Note that commands explicitly intended to run a particular script, such as will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `include` * Default: @@ -633,6 +790,9 @@ This is the inverse of `--omit=<type>`. Dependency types specified in `--include` 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 --> + #### `include-staged` * Default: false @@ -643,6 +803,9 @@ Allow installing "staged" published packages, as defined by [npm RFC PR This is experimental, and not implemented by the npm public registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init-author-email` * Default: "" @@ -650,6 +813,9 @@ This is experimental, and not implemented by the npm public registry. The value `npm init` should use by default for the package author's email. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init-author-name` * Default: "" @@ -657,6 +823,9 @@ The value `npm init` should use by default for the package author's email. The value `npm init` should use by default for the package author's name. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init-author-url` * Default: "" @@ -665,6 +834,9 @@ The value `npm init` should use by default for the package author's name. The value `npm init` should use by default for the package author's homepage. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init-license` * Default: "ISC" @@ -672,6 +844,9 @@ homepage. The value `npm init` should use by default for the package license. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init-module` * Default: "~/.npm-init.js" @@ -682,6 +857,9 @@ documentation for the [init-package-json](https://github.com/npm/init-package-json) module for more information, or [npm init](/commands/npm-init). +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init-version` * Default: "1.0.0" @@ -690,6 +868,9 @@ more information, or [npm init](/commands/npm-init). The value that `npm init` 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 --> + #### `json` * Default: false @@ -702,6 +883,9 @@ Whether or not to output JSON data, rather than the normal output. Not supported by all npm commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `key` * Default: null @@ -716,6 +900,9 @@ key="-----BEGIN PRIVATE KEY-----\nXXXX\nXXXX\n-----END PRIVATE KEY-----" It is _not_ the path to a key file (and there is no "keyfile" option). +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `legacy-bundling` * Default: false @@ -726,6 +913,9 @@ such as the one included with node 0.8, can install the package. This eliminates all automatic deduping. If used with `global-style` this option will be preferred. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `legacy-peer-deps` * Default: false @@ -744,6 +934,9 @@ This differs from `--omit=peer`, in that `--omit=peer` will avoid unpacking Use of `legacy-peer-deps` is not recommended, as it will not enforce the `peerDependencies` contract that meta-dependencies may rely on. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `link` * Default: false @@ -751,6 +944,9 @@ Use of `legacy-peer-deps` is not recommended, as it will not enforce the Used with `npm ls`, limiting output to only those packages that are linked. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `local-address` * Default: null @@ -759,6 +955,9 @@ Used with `npm ls`, limiting output to only those packages that are linked. 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 --> + #### `location` * Default: "user" unless `--global` is passed, which will also set this value @@ -767,6 +966,9 @@ npm registry. Must be IPv4 in versions of Node prior to 0.12. When passed to `npm config` this refers to which config file to use. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `loglevel` * Default: "notice" @@ -781,6 +983,9 @@ Any logs of a higher level than the setting are shown. The default is See also the `foreground-scripts` config. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `logs-max` * Default: 10 @@ -788,6 +993,9 @@ See also the `foreground-scripts` config. The maximum number of log files to store. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `long` * Default: false @@ -795,6 +1003,9 @@ The maximum number of log files to store. Show extended information in `ls`, `search`, and `help-search`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `maxsockets` * Default: 15 @@ -803,6 +1014,9 @@ Show extended information in `ls`, `search`, and `help-search`. 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 --> + #### `message` * Default: "%s" @@ -812,6 +1026,9 @@ Commit message which is used by `npm version` when creating version commit. Any "%s" in the message will be replaced with the version number. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `node-options` * Default: null @@ -821,6 +1038,9 @@ Options to pass through to Node.js via the `NODE_OPTIONS` 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 --> + #### `node-version` * Default: Node.js `process.version` value @@ -828,6 +1048,9 @@ how lifecycle scripts are called. The node version to use when checking a package's `engines` setting. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `noproxy` * Default: The value of the NO_PROXY environment variable @@ -837,6 +1060,9 @@ Domain extensions that should bypass any proxies. Also accepts a comma-delimited string. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `npm-version` * Default: Output of `npm --version` @@ -844,6 +1070,9 @@ Also accepts a comma-delimited string. The npm version to use when checking a package's `engines` setting. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `offline` * Default: false @@ -852,6 +1081,9 @@ The npm version to use when checking a package's `engines` setting. Force offline mode: no network requests will be done during install. To allow the CLI to fill in missing cache data, see `--prefer-offline`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `omit` * Default: 'dev' if the `NODE_ENV` environment variable is set to @@ -870,6 +1102,9 @@ it will be included. If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `otp` * Default: null @@ -881,6 +1116,9 @@ when publishing or changing package permissions with `npm access`. 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 --> + #### `pack-destination` * Default: "." @@ -888,6 +1126,9 @@ password, npm will prompt on the command line for one. Directory in which `npm pack` will save tarballs. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `package` * Default: @@ -895,6 +1136,9 @@ Directory in which `npm pack` will save tarballs. The package to install for [`npm exec`](/commands/npm-exec) +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `package-lock` * Default: true @@ -907,6 +1151,9 @@ When package package-locks are disabled, automatic pruning of extraneous modules will also be disabled. To remove extraneous modules with package-locks disabled use `npm prune`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `package-lock-only` * Default: false @@ -921,6 +1168,9 @@ instead of checking `node_modules` and downloading dependencies. For `list` this means the output will be based on the tree described by the `package-lock.json`, rather than the contents of `node_modules`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `parseable` * Default: false @@ -929,6 +1179,9 @@ For `list` this means the output will be based on the tree described by the Output parseable results from commands that write to standard output. For `npm search`, this will be tab-separated table format. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `prefer-offline` * Default: false @@ -938,6 +1191,9 @@ 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 `--offline`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `prefer-online` * Default: false @@ -946,6 +1202,9 @@ will be requested from the server. To force full offline mode, use 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 --> + #### `prefix` * Default: In global mode, the folder where the node executable is installed. @@ -956,6 +1215,9 @@ look for updates immediately even for fresh package data. 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 --> + #### `preid` * Default: "" @@ -964,6 +1226,9 @@ forces non-global commands to run in the specified folder. The "prerelease identifier" to use as a prefix for the "prerelease" part of a semver. Like the `rc` in `1.2.0-rc.8`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `progress` * Default: `true` unless running in a known CI system @@ -974,6 +1239,9 @@ operations, if `process.stderr` is a TTY. Set to `false` to suppress the progress bar. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `proxy` * Default: null @@ -983,6 +1251,9 @@ A proxy to use for outgoing http requests. If the `HTTP_PROXY` or `http_proxy` environment variables are set, proxy settings will be honored by the underlying `request` library. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `read-only` * Default: false @@ -991,6 +1262,9 @@ by the underlying `request` library. This is used to mark a token as unable to publish when configuring limited access tokens with the `npm token create` command. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `rebuild-bundle` * Default: true @@ -998,6 +1272,9 @@ access tokens with the `npm token create` command. Rebuild bundled dependencies after installation. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `registry` * Default: "https://registry.npmjs.org/" @@ -1005,6 +1282,9 @@ Rebuild bundled dependencies after installation. The base URL of the npm registry. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save` * Default: true @@ -1015,6 +1295,9 @@ Save installed packages to a package.json file as dependencies. When used with the `npm rm` command, removes the dependency from package.json. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save-bundle` * Default: false @@ -1026,6 +1309,9 @@ If a package would be saved at install time by the use of `--save`, Ignore if `--save-peer` is set, since peerDependencies cannot be bundled. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save-dev` * Default: false @@ -1033,6 +1319,9 @@ Ignore if `--save-peer` is set, since peerDependencies cannot be bundled. Save installed packages to a package.json file as `devDependencies`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save-exact` * Default: false @@ -1041,6 +1330,9 @@ Save installed packages to a package.json file as `devDependencies`. 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 --> + #### `save-optional` * Default: false @@ -1048,6 +1340,9 @@ rather than using npm's default semver range operator. Save installed packages to a package.json file as `optionalDependencies`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save-peer` * Default: false @@ -1055,6 +1350,9 @@ Save installed packages to a package.json file as `optionalDependencies`. Save installed packages. to a package.json file as `peerDependencies` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save-prefix` * Default: "^" @@ -1068,6 +1366,9 @@ to `^1.2.3` which allows minor upgrades for that package, but after `npm config set save-prefix='~'` it would be set to `~1.2.3` which only allows patch upgrades. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `save-prod` * Default: false @@ -1080,6 +1381,9 @@ you want to move it to be a non-optional production dependency. This is the default behavior if `--save` is true, and neither `--save-dev` or `--save-optional` are true. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `scope` * Default: the scope of the current project, if any, or "" @@ -1110,6 +1414,9 @@ npm init --scope=@foo --yes ``` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `script-shell` * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows @@ -1118,6 +1425,9 @@ npm init --scope=@foo --yes The shell to use for scripts run with the `npm exec`, `npm run` and `npm init <pkg>` commands. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `searchexclude` * Default: "" @@ -1125,6 +1435,9 @@ init <pkg>` commands. Space-separated options that limit the results from search. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `searchlimit` * Default: 20 @@ -1133,6 +1446,9 @@ Space-separated options that limit the results from search. 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 --> + #### `searchopts` * Default: "" @@ -1140,6 +1456,9 @@ searches. Space-separated options that are always passed to search. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `searchstaleness` * Default: 900 @@ -1148,6 +1467,9 @@ Space-separated options that are always passed to search. 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 --> + #### `shell` * Default: SHELL environment variable, or "bash" on Posix, or "cmd.exe" on @@ -1156,6 +1478,9 @@ using legacy search endpoint. The shell to run for the `npm explore` command. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `sign-git-commit` * Default: false @@ -1167,6 +1492,9 @@ version using `-S` to add a signature. 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 --> + #### `sign-git-tag` * Default: false @@ -1178,6 +1506,9 @@ If set to true, then the `npm version` command will tag the version using 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 --> + #### `strict-peer-deps` * Default: false @@ -1197,6 +1528,9 @@ When such and override is performed, a warning is printed, explaining the conflict and the packages involved. If `--strict-peer-deps` is set, then this warning is treated as a failure. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `strict-ssl` * Default: true @@ -1207,6 +1541,9 @@ via https. See also the `ca` config. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `tag` * Default: "latest" @@ -1221,6 +1558,9 @@ command, if no explicit tag is given. When used by the `npm diff` 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 --> + #### `tag-version-prefix` * Default: "v" @@ -1234,6 +1574,9 @@ Because other tools may rely on the convention that npm version tags look like `v1.0.0`, _only use this property if it is absolutely necessary_. In particular, use care when overriding this setting for public packages. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `timing` * Default: false @@ -1246,6 +1589,9 @@ successfully. `_timing.json` is a newline delimited list of JSON objects. You can quickly view it with this [json](https://npm.im/json) command line: `npm exec -- json -g < ~/.npm/_timing.json`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `umask` * Default: 0 @@ -1266,6 +1612,9 @@ 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 --> + #### `unicode` * Default: false on windows, true on mac/unix systems with a unicode locale, @@ -1275,6 +1624,9 @@ other files are created with a mode of 0o644. 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 --> + #### `update-notifier` * Default: true @@ -1283,6 +1635,9 @@ false, it uses ascii characters instead of unicode glyphs. 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 --> + #### `usage` * Default: false @@ -1290,6 +1645,9 @@ of npm than the latest. Show short usage output about the command specified. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `user-agent` * Default: "npm/{npm-version} node/{node-version} {platform} {arch} @@ -1308,6 +1666,9 @@ their actual counterparts: * `{ci}` - The value of the `ci-name` config, if set, prefixed with `ci/`, or an empty string if `ci-name` is empty. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `userconfig` * Default: "~/.npmrc" @@ -1319,6 +1680,9 @@ This may be overridden by the `npm_config_userconfig` environment variable or the `--userconfig` command line option, but may _not_ be overridden by settings in the `globalconfig` file. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `version` * Default: false @@ -1328,6 +1692,9 @@ If true, output the npm version and exit successfully. Only relevant when specified explicitly on the command line. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `versions` * Default: false @@ -1339,6 +1706,9 @@ exists, and exit successfully. Only relevant when specified explicitly on the command line. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `viewer` * Default: "man" on Posix, "browser" on Windows @@ -1348,6 +1718,9 @@ The program to use to view help content. Set to `"browser"` to view html help content in the default web browser. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `which` * Default: null @@ -1355,6 +1728,9 @@ Set to `"browser"` to view html help content in the default web browser. 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 --> + #### `workspace` * Default: @@ -1377,6 +1753,9 @@ brand new workspace within the project. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `workspaces` * Default: false @@ -1387,6 +1766,9 @@ workspaces. This value is not exported to the environment for child processes. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `yes` * Default: null @@ -1395,6 +1777,9 @@ This value is not exported to the environment for child processes. 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 --> + #### `also` * Default: null @@ -1403,6 +1788,9 @@ command line. When set to `dev` or `development`, this is an alias for `--include=dev`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `auth-type` * Default: "legacy" @@ -1412,6 +1800,9 @@ When set to `dev` or `development`, this is an alias for `--include=dev`. What authentication strategy to use with `adduser`/`login`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `cache-max` * Default: Infinity @@ -1420,6 +1811,9 @@ What authentication strategy to use with `adduser`/`login`. `--cache-max=0` is an alias for `--prefer-online` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `cache-min` * Default: 0 @@ -1428,6 +1822,9 @@ What authentication strategy to use with `adduser`/`login`. `--cache-min=9999 (or bigger)` is an alias for `--prefer-offline`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `dev` * Default: false @@ -1436,6 +1833,9 @@ What authentication strategy to use with `adduser`/`login`. Alias for `--include=dev`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init.author.email` * Default: "" @@ -1444,6 +1844,9 @@ Alias for `--include=dev`. Alias for `--init-author-email` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init.author.name` * Default: "" @@ -1452,6 +1855,9 @@ Alias for `--init-author-email` Alias for `--init-author-name` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init.author.url` * Default: "" @@ -1460,6 +1866,9 @@ Alias for `--init-author-name` Alias for `--init-author-url` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init.license` * Default: "ISC" @@ -1468,6 +1877,9 @@ Alias for `--init-author-url` Alias for `--init-license` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init.module` * Default: "~/.npm-init.js" @@ -1476,6 +1888,9 @@ Alias for `--init-license` Alias for `--init-module` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `init.version` * Default: "1.0.0" @@ -1484,6 +1899,9 @@ Alias for `--init-module` Alias for `--init-version` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `only` * Default: null @@ -1492,6 +1910,9 @@ Alias for `--init-version` When set to `prod` or `production`, this is an alias for `--omit=dev`. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `optional` * Default: null @@ -1503,6 +1924,9 @@ Default value does install optional deps unless otherwise omitted. Alias for --include=optional or --omit=optional +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `production` * Default: null @@ -1511,6 +1935,9 @@ Alias for --include=optional or --omit=optional Alias for `--omit=dev` +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `shrinkwrap` * Default: true @@ -1519,6 +1946,9 @@ Alias for `--omit=dev` Alias for --package-lock +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `sso-poll-frequency` * Default: 500 @@ -1529,6 +1959,9 @@ Alias for --package-lock When used with SSO-enabled `auth-type`s, 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 --> + #### `sso-type` * Default: "oauth" @@ -1538,6 +1971,9 @@ registry should be polled while the user is completing authentication. If `--auth-type=sso`, the type of SSO type to use. +<!-- automatically generated, do not edit manually --> +<!-- see lib/utils/config/definitions.js --> + #### `tmp` * Default: The value returned by the Node.js `os.tmpdir()` method @@ -1550,6 +1986,8 @@ If `--auth-type=sso`, the type of SSO type to use. 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 --> ### See also |