File Explorer

1.TH "CONFIG" "7" "February 2026" "NPM@11.11.0" ""2.SH "NAME"3\fBConfig\fR - About npm configuration4.SS "Description"5.P6This article details npm configuration in general. To learn about the \fBconfig\fR command, see npm help config.7.P8npm gets its configuration values from the following sources, sorted by priority:9.SS "Command Line Flags"10.P11Putting \fB--foo bar\fR on the command line sets the \fBfoo\fR configuration parameter to \fB"bar"\fR. A \fB--\fR argument tells the cli parser to stop reading flags. Using \fB--flag\fR without specifying any value will set the value to \fBtrue\fR.12.P13Example: \fB--flag1 --flag2\fR will set both configuration parameters to \fBtrue\fR, while \fB--flag1 --flag2 bar\fR will set \fBflag1\fR to \fBtrue\fR, and \fBflag2\fR to \fBbar\fR. Finally, \fB--flag1 --flag2 -- bar\fR will set both configuration parameters to \fBtrue\fR, and the \fBbar\fR is taken as a command argument.14.P15\fBCommon examples:\fR16.RS 017.IP \(bu 418\fBnpm install --prefix /path/to/dir\fR - Runs npm commands in a different directory without changing the current working directory19.IP \(bu 420\fBnpm install --global\fR - Installs packages globally (shorthand: \fB-g\fR)21.IP \(bu 422\fBnpm install --save-dev\fR - Saves to devDependencies (shorthand: \fB-D\fR)23.RE 024 25.P26Any configuration option documented in the \fI(Config Settings)\fR section below can be set via command line flags using \fB--option-name value\fR syntax.27.SS "Environment Variables"28.P29Any environment variables that start with \fBnpm_config_\fR will be interpreted as a configuration parameter. For example, putting \fBnpm_config_foo=bar\fR in your environment will set the \fBfoo\fR configuration parameter to \fBbar\fR. Any environment configurations that are not given a value will be given the value of \fBtrue\fR. Config values are case-insensitive, so \fBNPM_CONFIG_FOO=bar\fR will work the same. However, please note that inside npm help scripts npm will set its own environment variables and Node will prefer those lowercase versions over any uppercase ones that you might set. For details see \fBthis issue\fR \fI\(lahttps://github.com/npm/npm/issues/14528\(ra\fR.30.P31Notice that you need to use underscores instead of dashes, so \fB--allow-same-version\fR would become \fBnpm_config_allow_same_version=true\fR.32.P33\fBImportant:\fR When defining custom configuration keys in \fB.npmrc\fR files, use hyphens instead of underscores (e.g., \fBcustom-key=value\fR). This ensures they can be overridden by environment variables, since npm automatically converts underscores to hyphens when reading environment variables. Keys with underscores in \fB.npmrc\fR files cannot be overridden via environment variables.34.SS "npmrc Files"35.P36The four relevant files are:37.RS 038.IP \(bu 439per-project configuration file (\fB/path/to/my/project/.npmrc\fR)40.IP \(bu 441per-user configuration file (defaults to \fB$HOME/.npmrc\fR; configurable via CLI option \fB--userconfig\fR or environment variable \fB$NPM_CONFIG_USERCONFIG\fR)42.IP \(bu 443global configuration file (defaults to \fB$PREFIX/etc/npmrc\fR; configurable via CLI option \fB--globalconfig\fR or environment variable \fB$NPM_CONFIG_GLOBALCONFIG\fR)44.IP \(bu 445npm's built-in configuration file (\fB/path/to/npm/npmrc\fR)46.RE 047 48.P49See npm help npmrc for more details.50.SS "Default Configs"51.P52Run \fBnpm config ls -l\fR to see a set of configuration parameters that are internal to npm, and are defaults if nothing else is specified.53.SS "Shorthands and Other CLI Niceties"54.P55The following shorthands are parsed on the command-line:56.RS 057.IP \(bu 458\fB-a\fR: \fB--all\fR59.IP \(bu 460\fB--enjoy-by\fR: \fB--before\fR61.IP \(bu 462\fB-c\fR: \fB--call\fR63.IP \(bu 464\fB--desc\fR: \fB--description\fR65.IP \(bu 466\fB-f\fR: \fB--force\fR67.IP \(bu 468\fB-g\fR: \fB--global\fR69.IP \(bu 470\fB--iwr\fR: \fB--include-workspace-root\fR71.IP \(bu 472\fB-L\fR: \fB--location\fR73.IP \(bu 474\fB-d\fR: \fB--loglevel info\fR75.IP \(bu 476\fB-s\fR: \fB--loglevel silent\fR77.IP \(bu 478\fB--silent\fR: \fB--loglevel silent\fR79.IP \(bu 480\fB--ddd\fR: \fB--loglevel silly\fR81.IP \(bu 482\fB--dd\fR: \fB--loglevel verbose\fR83.IP \(bu 484\fB--verbose\fR: \fB--loglevel verbose\fR85.IP \(bu 486\fB-q\fR: \fB--loglevel warn\fR87.IP \(bu 488\fB--quiet\fR: \fB--loglevel warn\fR89.IP \(bu 490\fB-l\fR: \fB--long\fR91.IP \(bu 492\fB-m\fR: \fB--message\fR93.IP \(bu 494\fB--local\fR: \fB--no-global\fR95.IP \(bu 496\fB-n\fR: \fB--no-yes\fR97.IP \(bu 498\fB--no\fR: \fB--no-yes\fR99.IP \(bu 4100\fB-p\fR: \fB--parseable\fR101.IP \(bu 4102\fB--porcelain\fR: \fB--parseable\fR103.IP \(bu 4104\fB-C\fR: \fB--prefix\fR105.IP \(bu 4106\fB--readonly\fR: \fB--read-only\fR107.IP \(bu 4108\fB--reg\fR: \fB--registry\fR109.IP \(bu 4110\fB-S\fR: \fB--save\fR111.IP \(bu 4112\fB-B\fR: \fB--save-bundle\fR113.IP \(bu 4114\fB-D\fR: \fB--save-dev\fR115.IP \(bu 4116\fB-E\fR: \fB--save-exact\fR117.IP \(bu 4118\fB-O\fR: \fB--save-optional\fR119.IP \(bu 4120\fB-P\fR: \fB--save-prod\fR121.IP \(bu 4122\fB-?\fR: \fB--usage\fR123.IP \(bu 4124\fB-h\fR: \fB--usage\fR125.IP \(bu 4126\fB-H\fR: \fB--usage\fR127.IP \(bu 4128\fB--help\fR: \fB--usage\fR129.IP \(bu 4130\fB-v\fR: \fB--version\fR131.IP \(bu 4132\fB-w\fR: \fB--workspace\fR133.IP \(bu 4134\fB--ws\fR: \fB--workspaces\fR135.IP \(bu 4136\fB-y\fR: \fB--yes\fR137.RE 0138 139.P140If the specified configuration param resolves unambiguously to a known configuration parameter, then it is expanded to that configuration parameter. For example:141.P142.RS 2143.nf144npm ls --par145# same as:146npm ls --parseable147.fi148.RE149.P150If multiple single-character shorthands are strung together, and the resulting combination is unambiguously not some other configuration param, then it is expanded to its various component pieces. For example:151.P152.RS 2153.nf154npm ls -gpld155# same as:156npm ls --global --parseable --long --loglevel info157.fi158.RE159.SS "Config Settings"160.SS "\fB_auth\fR"161.RS 0162.IP \(bu 4163Default: null164.IP \(bu 4165Type: null or String166.RE 0167 168.P169A basic-auth string to use when authenticating against the npm registry. This will ONLY be used to authenticate against the npm registry. For other registries you will need to scope it like "//other-registry.tld/:_auth"170.P171Warning: 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\fR.172.SS "\fBaccess\fR"173.RS 0174.IP \(bu 4175Default: 'public' for new packages, existing packages it will not change the current level176.IP \(bu 4177Type: null, "restricted", or "public"178.RE 0179 180.P181If you do not want your scoped package to be publicly viewable (and installable) set \fB--access=restricted\fR.182.P183Unscoped packages cannot be set to \fBrestricted\fR.184.P185Note: This defaults to not changing the current access level for existing packages. Specifying a value of \fBrestricted\fR or \fBpublic\fR during publish will change the access for an existing package the same way that \fBnpm access set186status\fR would.187.SS "\fBall\fR"188.RS 0189.IP \(bu 4190Default: false191.IP \(bu 4192Type: Boolean193.RE 0194 195.P196When running \fBnpm outdated\fR and \fBnpm ls\fR, setting \fB--all\fR will show all outdated or installed packages, rather than only those directly depended upon by the current project.197.SS "\fBallow-git\fR"198.RS 0199.IP \(bu 4200Default: "all"201.IP \(bu 4202Type: "all", "none", or "root"203.RE 0204 205.P206Limits the ability for npm to fetch dependencies from git references. That is, dependencies that point to a git repo instead of a version or semver range. Please note that this could leave your tree incomplete and some packages may not function as intended or designed.207.P208\fBall\fR allows any git dependencies to be fetched and installed. \fBnone\fR prevents any git dependencies from being fetched and installed. \fBroot\fR only allows git dependencies defined in your project's package.json to be fetched installed. Also allows git dependencies to be fetched for other commands like \fBnpm view\fR209.SS "\fBallow-same-version\fR"210.RS 0211.IP \(bu 4212Default: false213.IP \(bu 4214Type: Boolean215.RE 0216 217.P218Prevents throwing an error when \fBnpm version\fR is used to set the new version to the same value as the current version.219.SS "\fBaudit\fR"220.RS 0221.IP \(bu 4222Default: true223.IP \(bu 4224Type: Boolean225.RE 0226 227.P228When "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 audit for details on what is submitted.229.SS "\fBaudit-level\fR"230.RS 0231.IP \(bu 4232Default: null233.IP \(bu 4234Type: null, "info", "low", "moderate", "high", "critical", or "none"235.RE 0236 237.P238The minimum level of vulnerability for \fBnpm audit\fR to exit with a non-zero exit code.239.SS "\fBauth-type\fR"240.RS 0241.IP \(bu 4242Default: "web"243.IP \(bu 4244Type: "legacy" or "web"245.RE 0246 247.P248What authentication strategy to use with \fBlogin\fR. Note that if an \fBotp\fR config is given, this value will always be set to \fBlegacy\fR.249.SS "\fBbefore\fR"250.RS 0251.IP \(bu 4252Default: null253.IP \(bu 4254Type: null or Date255.RE 0256 257.P258If passed to \fBnpm install\fR, will rebuild the npm tree such that only versions that were available \fBon or before\fR the given date are installed. If there are no versions available for the current set of dependencies, the command will error.259.P260If the requested version is a \fBdist-tag\fR and the given tag does not pass the \fB--before\fR filter, the most recent version less than or equal to that tag will be used. For example, \fBfoo@latest\fR might install \fBfoo@1.2\fR even though \fBlatest\fR is \fB2.0\fR.261.P262This config cannot be used with: \fBmin-release-age\fR263.SS "\fBbin-links\fR"264.RS 0265.IP \(bu 4266Default: true267.IP \(bu 4268Type: Boolean269.RE 0270 271.P272Tells npm to create symlinks (or \fB.cmd\fR shims on Windows) for package executables.273.P274Set 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.275.SS "\fBbrowser\fR"276.RS 0277.IP \(bu 4278Default: macOS: \fB"open"\fR, Windows: \fB"start"\fR, Others: \fB"xdg-open"\fR279.IP \(bu 4280Type: null, Boolean, or String281.RE 0282 283.P284The browser that is called by npm commands to open websites.285.P286Set to \fBfalse\fR to suppress browser behavior and instead print urls to terminal.287.P288Set to \fBtrue\fR to use default system URL opener.289.SS "\fBbypass-2fa\fR"290.RS 0291.IP \(bu 4292Default: false293.IP \(bu 4294Type: Boolean295.RE 0296 297.P298When creating a Granular Access Token with \fBnpm token create\fR, setting this to true will allow the token to bypass two-factor authentication. This is useful for automation and CI/CD workflows.299.SS "\fBca\fR"300.RS 0301.IP \(bu 4302Default: null303.IP \(bu 4304Type: null or String (can be set multiple times)305.RE 0306 307.P308The Certificate Authority signing certificate that is trusted for SSL connections to the registry. Values should be in PEM format (Windows calls it "Base-64 encoded X.509 (.CER)") with newlines replaced by the string "\[rs]n". For example:309.P310.RS 2311.nf312ca="-----BEGIN CERTIFICATE-----\[rs]nXXXX\[rs]nXXXX\[rs]n-----END CERTIFICATE-----"313.fi314.RE315.P316Set to \fBnull\fR to only allow "known" registrars, or to a specific CA cert to trust only that specific signing authority.317.P318Multiple CAs can be trusted by specifying an array of certificates:319.P320.RS 2321.nf322ca\[lB]\[rB]="..."323ca\[lB]\[rB]="..."324.fi325.RE326.P327See also the \fBstrict-ssl\fR config.328.SS "\fBcache\fR"329.RS 0330.IP \(bu 4331Default: Windows: \fB%LocalAppData%\[rs]npm-cache\fR, Posix: \fB~/.npm\fR332.IP \(bu 4333Type: Path334.RE 0335 336.P337The location of npm's cache directory.338.SS "\fBcafile\fR"339.RS 0340.IP \(bu 4341Default: null342.IP \(bu 4343Type: Path344.RE 0345 346.P347A path to a file containing one or multiple Certificate Authority signing certificates. Similar to the \fBca\fR setting, but allows for multiple CA's, as well as for the CA information to be stored in a file on disk.348.SS "\fBcall\fR"349.RS 0350.IP \(bu 4351Default: ""352.IP \(bu 4353Type: String354.RE 0355 356.P357Optional companion option for \fBnpm exec\fR, \fBnpx\fR that allows for specifying a custom command to be run along with the installed packages.358.P359.RS 2360.nf361npm exec --package yo --package generator-node --call "yo node"362.fi363.RE364.SS "\fBcidr\fR"365.RS 0366.IP \(bu 4367Default: null368.IP \(bu 4369Type: null or String (can be set multiple times)370.RE 0371 372.P373This is a list of CIDR address to be used when configuring limited access tokens with the \fBnpm token create\fR command.374.SS "\fBcolor\fR"375.RS 0376.IP \(bu 4377Default: true unless the NO_COLOR environ is set to something other than '0'378.IP \(bu 4379Type: "always" or Boolean380.RE 0381 382.P383If false, never shows colors. If \fB"always"\fR then always shows colors. If true, then only prints color codes for tty file descriptors.384.SS "\fBcommit-hooks\fR"385.RS 0386.IP \(bu 4387Default: true388.IP \(bu 4389Type: Boolean390.RE 0391 392.P393Run git commit hooks when using the \fBnpm version\fR command.394.SS "\fBcpu\fR"395.RS 0396.IP \(bu 4397Default: null398.IP \(bu 4399Type: null or String400.RE 0401 402.P403Override CPU architecture of native modules to install. Acceptable values are same as \fBcpu\fR field of package.json, which comes from \fBprocess.arch\fR.404.SS "\fBdepth\fR"405.RS 0406.IP \(bu 4407Default: \fBInfinity\fR if \fB--all\fR is set; otherwise, \fB0\fR408.IP \(bu 4409Type: null or Number410.RE 0411 412.P413The depth to go when recursing packages for \fBnpm ls\fR.414.P415If not set, \fBnpm ls\fR will show only the immediate dependencies of the root project. If \fB--all\fR is set, then npm will show all dependencies by default.416.SS "\fBdescription\fR"417.RS 0418.IP \(bu 4419Default: true420.IP \(bu 4421Type: Boolean422.RE 0423 424.P425Show the description in \fBnpm search\fR426.SS "\fBdiff\fR"427.RS 0428.IP \(bu 4429Default:430.IP \(bu 4431Type: String (can be set multiple times)432.RE 0433 434.P435Define arguments to compare in \fBnpm diff\fR.436.SS "\fBdiff-dst-prefix\fR"437.RS 0438.IP \(bu 4439Default: "b/"440.IP \(bu 4441Type: String442.RE 0443 444.P445Destination prefix to be used in \fBnpm diff\fR output.446.SS "\fBdiff-ignore-all-space\fR"447.RS 0448.IP \(bu 4449Default: false450.IP \(bu 4451Type: Boolean452.RE 0453 454.P455Ignore whitespace when comparing lines in \fBnpm diff\fR.456.SS "\fBdiff-name-only\fR"457.RS 0458.IP \(bu 4459Default: false460.IP \(bu 4461Type: Boolean462.RE 0463 464.P465Prints only filenames when using \fBnpm diff\fR.466.SS "\fBdiff-no-prefix\fR"467.RS 0468.IP \(bu 4469Default: false470.IP \(bu 4471Type: Boolean472.RE 0473 474.P475Do not show any source or destination prefix in \fBnpm diff\fR output.476.P477Note: this causes \fBnpm diff\fR to ignore the \fB--diff-src-prefix\fR and \fB--diff-dst-prefix\fR configs.478.SS "\fBdiff-src-prefix\fR"479.RS 0480.IP \(bu 4481Default: "a/"482.IP \(bu 4483Type: String484.RE 0485 486.P487Source prefix to be used in \fBnpm diff\fR output.488.SS "\fBdiff-text\fR"489.RS 0490.IP \(bu 4491Default: false492.IP \(bu 4493Type: Boolean494.RE 0495 496.P497Treat all files as text in \fBnpm diff\fR.498.SS "\fBdiff-unified\fR"499.RS 0500.IP \(bu 4501Default: 3502.IP \(bu 4503Type: Number504.RE 0505 506.P507The number of lines of context to print in \fBnpm diff\fR.508.SS "\fBdry-run\fR"509.RS 0510.IP \(bu 4511Default: false512.IP \(bu 4513Type: Boolean514.RE 0515 516.P517Indicates that you don't want npm to make any changes and that it should only report what it would have done. This can be passed into any of the commands that modify your local installation, eg, \fBinstall\fR, \fBupdate\fR, \fBdedupe\fR, \fBuninstall\fR, as well as \fBpack\fR and \fBpublish\fR.518.P519Note: This is NOT honored by other network related commands, eg \fBdist-tags\fR, \fBowner\fR, etc.520.SS "\fBeditor\fR"521.RS 0522.IP \(bu 4523Default: The EDITOR or VISUAL environment variables, or '%SYSTEMROOT%\[rs]notepad.exe' on Windows, or 'vi' on Unix systems524.IP \(bu 4525Type: String526.RE 0527 528.P529The command to run for \fBnpm edit\fR and \fBnpm config edit\fR.530.SS "\fBengine-strict\fR"531.RS 0532.IP \(bu 4533Default: false534.IP \(bu 4535Type: Boolean536.RE 0537 538.P539If set to true, then npm will stubbornly refuse to install (or even consider installing) any package that claims to not be compatible with the current Node.js version.540.P541This can be overridden by setting the \fB--force\fR flag.542.SS "\fBexpect-result-count\fR"543.RS 0544.IP \(bu 4545Default: null546.IP \(bu 4547Type: null or Number548.RE 0549 550.P551Tells to expect a specific number of results from the command.552.P553This config cannot be used with: \fBexpect-results\fR554.SS "\fBexpect-results\fR"555.RS 0556.IP \(bu 4557Default: null558.IP \(bu 4559Type: null or Boolean560.RE 0561 562.P563Tells npm whether or not to expect results from the command. Can be either true (expect some results) or false (expect no results).564.P565This config cannot be used with: \fBexpect-result-count\fR566.SS "\fBexpires\fR"567.RS 0568.IP \(bu 4569Default: null570.IP \(bu 4571Type: null or Number572.RE 0573 574.P575When creating a Granular Access Token with \fBnpm token create\fR, this sets the expiration in days. If not specified, the server will determine the default expiration.576.SS "\fBfetch-retries\fR"577.RS 0578.IP \(bu 4579Default: 2580.IP \(bu 4581Type: Number582.RE 0583 584.P585The "retries" config for the \fBretry\fR module to use when fetching packages from the registry.586.P587npm will retry idempotent read requests to the registry in the case of network failures or 5xx HTTP errors.588.SS "\fBfetch-retry-factor\fR"589.RS 0590.IP \(bu 4591Default: 10592.IP \(bu 4593Type: Number594.RE 0595 596.P597The "factor" config for the \fBretry\fR module to use when fetching packages.598.SS "\fBfetch-retry-maxtimeout\fR"599.RS 0600.IP \(bu 4601Default: 60000 (1 minute)602.IP \(bu 4603Type: Number604.RE 0605 606.P607The "maxTimeout" config for the \fBretry\fR module to use when fetching packages.608.SS "\fBfetch-retry-mintimeout\fR"609.RS 0610.IP \(bu 4611Default: 10000 (10 seconds)612.IP \(bu 4613Type: Number614.RE 0615 616.P617The "minTimeout" config for the \fBretry\fR module to use when fetching packages.618.SS "\fBfetch-timeout\fR"619.RS 0620.IP \(bu 4621Default: 300000 (5 minutes)622.IP \(bu 4623Type: Number624.RE 0625 626.P627The maximum amount of time to wait for HTTP requests to complete.628.SS "\fBforce\fR"629.RS 0630.IP \(bu 4631Default: false632.IP \(bu 4633Type: Boolean634.RE 0635 636.P637Removes various protections against unfortunate side effects, common mistakes, unnecessary performance degradation, and malicious input.638.RS 0639.IP \(bu 4640Allow clobbering non-npm files in global installs.641.IP \(bu 4642Allow the \fBnpm version\fR command to work on an unclean git repository.643.IP \(bu 4644Allow deleting the cache folder with \fBnpm cache clean\fR.645.IP \(bu 4646Allow installing packages that have an \fBengines\fR declaration requiring a different version of npm.647.IP \(bu 4648Allow installing packages that have an \fBengines\fR declaration requiring a different version of \fBnode\fR, even if \fB--engine-strict\fR is enabled.649.IP \(bu 4650Allow \fBnpm audit fix\fR to install modules outside your stated dependency range (including SemVer-major changes).651.IP \(bu 4652Allow unpublishing all versions of a published package.653.IP \(bu 4654Allow conflicting peerDependencies to be installed in the root project.655.IP \(bu 4656Implicitly set \fB--yes\fR during \fBnpm init\fR.657.IP \(bu 4658Allow clobbering existing values in \fBnpm pkg\fR659.IP \(bu 4660Allow unpublishing of entire packages (not just a single version).661.RE 0662 663.P664If you don't have a clear idea of what you want to do, it is strongly recommended that you do not use this option!665.SS "\fBforeground-scripts\fR"666.RS 0667.IP \(bu 4668Default: \fBfalse\fR unless when using \fBnpm pack\fR or \fBnpm publish\fR where it defaults to \fBtrue\fR669.IP \(bu 4670Type: Boolean671.RE 0672 673.P674Run all build scripts (ie, \fBpreinstall\fR, \fBinstall\fR, and \fBpostinstall\fR) scripts for installed packages in the foreground process, sharing standard input, output, and error with the main npm process.675.P676Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging.677.SS "\fBformat-package-lock\fR"678.RS 0679.IP \(bu 4680Default: true681.IP \(bu 4682Type: Boolean683.RE 0684 685.P686Format \fBpackage-lock.json\fR or \fBnpm-shrinkwrap.json\fR as a human readable file.687.SS "\fBfund\fR"688.RS 0689.IP \(bu 4690Default: true691.IP \(bu 4692Type: Boolean693.RE 0694 695.P696When "true" displays the message at the end of each \fBnpm install\fR acknowledging the number of dependencies looking for funding. See npm help fund for details.697.SS "\fBgit\fR"698.RS 0699.IP \(bu 4700Default: "git"701.IP \(bu 4702Type: String703.RE 0704 705.P706The command to use for git commands. If git is installed on the computer, but is not in the \fBPATH\fR, then set this to the full path to the git binary.707.SS "\fBgit-tag-version\fR"708.RS 0709.IP \(bu 4710Default: true711.IP \(bu 4712Type: Boolean713.RE 0714 715.P716Tag the commit when using the \fBnpm version\fR command. Setting this to false results in no commit being made at all.717.SS "\fBglobal\fR"718.RS 0719.IP \(bu 4720Default: false721.IP \(bu 4722Type: Boolean723.RE 0724 725.P726Operates in "global" mode, so that packages are installed into the \fBprefix\fR folder instead of the current working directory. See npm help folders for more on the differences in behavior.727.RS 0728.IP \(bu 4729packages are installed into the \fB{prefix}/lib/node_modules\fR folder, instead of the current working directory.730.IP \(bu 4731bin files are linked to \fB{prefix}/bin\fR732.IP \(bu 4733man pages are linked to \fB{prefix}/share/man\fR734.RE 0735 736.SS "\fBglobalconfig\fR"737.RS 0738.IP \(bu 4739Default: The global --prefix setting plus 'etc/npmrc'. For example, '/usr/local/etc/npmrc'740.IP \(bu 4741Type: Path742.RE 0743 744.P745The config file to read for global config options.746.SS "\fBheading\fR"747.RS 0748.IP \(bu 4749Default: "npm"750.IP \(bu 4751Type: String752.RE 0753 754.P755The string that starts all the debugging log output.756.SS "\fBhttps-proxy\fR"757.RS 0758.IP \(bu 4759Default: null760.IP \(bu 4761Type: null or URL762.RE 0763 764.P765A proxy to use for outgoing https requests. If the \fBHTTPS_PROXY\fR or \fBhttps_proxy\fR or \fBHTTP_PROXY\fR or \fBhttp_proxy\fR environment variables are set, proxy settings will be honored by the underlying \fBmake-fetch-happen\fR library.766.SS "\fBif-present\fR"767.RS 0768.IP \(bu 4769Default: false770.IP \(bu 4771Type: Boolean772.RE 0773 774.P775If true, npm will not exit with an error code when \fBrun\fR is invoked for a script that isn't defined in the \fBscripts\fR section of \fBpackage.json\fR. 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.776.P777This value is not exported to the environment for child processes.778.SS "\fBignore-scripts\fR"779.RS 0780.IP \(bu 4781Default: false782.IP \(bu 4783Type: Boolean784.RE 0785 786.P787If true, npm does not run scripts specified in package.json files.788.P789Note that commands explicitly intended to run a particular script, such as \fBnpm start\fR, \fBnpm stop\fR, \fBnpm restart\fR, \fBnpm test\fR, and \fBnpm run\fR will still run their intended script if \fBignore-scripts\fR is set, but they will \fInot\fR run any pre- or post-scripts.790.SS "\fBinclude\fR"791.RS 0792.IP \(bu 4793Default:794.IP \(bu 4795Type: "prod", "dev", "optional", or "peer" (can be set multiple times)796.RE 0797 798.P799Option that allows for defining which types of dependencies to install.800.P801This is the inverse of \fB--omit=<type>\fR.802.P803Dependency types specified in \fB--include\fR will not be omitted, regardless of the order in which omit/include are specified on the command-line.804.SS "\fBinclude-staged\fR"805.RS 0806.IP \(bu 4807Default: false808.IP \(bu 4809Type: Boolean810.RE 0811 812.P813Allow installing "staged" published packages, as defined by \fBnpm RFC PR #92\fR \fI\(lahttps://github.com/npm/rfcs/pull/92\(ra\fR.814.P815This is experimental, and not implemented by the npm public registry.816.SS "\fBinclude-workspace-root\fR"817.RS 0818.IP \(bu 4819Default: false820.IP \(bu 4821Type: Boolean822.RE 0823 824.P825Include the workspace root when workspaces are enabled for a command.826.P827When false, specifying individual workspaces via the \fBworkspace\fR config, or all workspaces via the \fBworkspaces\fR flag, will cause npm to operate only on the specified workspaces, and not on the root project.828.P829This value is not exported to the environment for child processes.830.SS "\fBinit-author-email\fR"831.RS 0832.IP \(bu 4833Default: ""834.IP \(bu 4835Type: String836.RE 0837 838.P839The value \fBnpm init\fR should use by default for the package author's email.840.SS "\fBinit-author-name\fR"841.RS 0842.IP \(bu 4843Default: ""844.IP \(bu 4845Type: String846.RE 0847 848.P849The value \fBnpm init\fR should use by default for the package author's name.850.SS "\fBinit-author-url\fR"851.RS 0852.IP \(bu 4853Default: ""854.IP \(bu 4855Type: "" or URL856.RE 0857 858.P859The value \fBnpm init\fR should use by default for the package author's homepage.860.SS "\fBinit-license\fR"861.RS 0862.IP \(bu 4863Default: "ISC"864.IP \(bu 4865Type: String866.RE 0867 868.P869The value \fBnpm init\fR should use by default for the package license.870.SS "\fBinit-module\fR"871.RS 0872.IP \(bu 4873Default: "~/.npm-init.js"874.IP \(bu 4875Type: Path876.RE 0877 878.P879A module that will be loaded by the \fBnpm init\fR command. See the documentation for the \fBinit-package-json\fR \fI\(lahttps://github.com/npm/init-package-json\(ra\fR module for more information, or npm help init.880.SS "\fBinit-private\fR"881.RS 0882.IP \(bu 4883Default: false884.IP \(bu 4885Type: Boolean886.RE 0887 888.P889The value \fBnpm init\fR should use by default for the package's private flag.890.SS "\fBinit-type\fR"891.RS 0892.IP \(bu 4893Default: "commonjs"894.IP \(bu 4895Type: String896.RE 0897 898.P899The value that \fBnpm init\fR should use by default for the package.json type field.900.SS "\fBinit-version\fR"901.RS 0902.IP \(bu 4903Default: "1.0.0"904.IP \(bu 4905Type: SemVer string906.RE 0907 908.P909The value that \fBnpm init\fR should use by default for the package version number, if not already set in package.json.910.SS "\fBinstall-links\fR"911.RS 0912.IP \(bu 4913Default: false914.IP \(bu 4915Type: Boolean916.RE 0917 918.P919When set file: protocol dependencies will be packed and installed as regular dependencies instead of creating a symlink. This option has no effect on workspaces.920.SS "\fBinstall-strategy\fR"921.RS 0922.IP \(bu 4923Default: "hoisted"924.IP \(bu 4925Type: "hoisted", "nested", "shallow", or "linked"926.RE 0927 928.P929Sets the strategy for installing packages in node_modules. hoisted (default): Install non-duplicated in top-level, and duplicated as necessary within directory structure. nested: (formerly --legacy-bundling) install in place, no hoisting. shallow (formerly --global-style) only install direct deps at top-level. linked: (experimental) install in node_modules/.store, link in place, unhoisted.930.SS "\fBjson\fR"931.RS 0932.IP \(bu 4933Default: false934.IP \(bu 4935Type: Boolean936.RE 0937 938.P939Whether or not to output JSON data, rather than the normal output.940.RS 0941.IP \(bu 4942In \fBnpm pkg set\fR it enables parsing set values with JSON.parse() before saving them to your \fBpackage.json\fR.943.RE 0944 945.P946Not supported by all npm commands.947.SS "\fBlegacy-peer-deps\fR"948.RS 0949.IP \(bu 4950Default: false951.IP \(bu 4952Type: Boolean953.RE 0954 955.P956Causes npm to completely ignore \fBpeerDependencies\fR when building a package tree, as in npm versions 3 through 6.957.P958If a package cannot be installed because of overly strict \fBpeerDependencies\fR that collide, it provides a way to move forward resolving the situation.959.P960This differs from \fB--omit=peer\fR, in that \fB--omit=peer\fR will avoid unpacking \fBpeerDependencies\fR on disk, but will still design a tree such that \fBpeerDependencies\fR \fIcould\fR be unpacked in a correct place.961.P962Use of \fBlegacy-peer-deps\fR is not recommended, as it will not enforce the \fBpeerDependencies\fR contract that meta-dependencies may rely on.963.SS "\fBlibc\fR"964.RS 0965.IP \(bu 4966Default: null967.IP \(bu 4968Type: null or String969.RE 0970 971.P972Override libc of native modules to install. Acceptable values are same as \fBlibc\fR field of package.json973.SS "\fBlink\fR"974.RS 0975.IP \(bu 4976Default: false977.IP \(bu 4978Type: Boolean979.RE 0980 981.P982Used with \fBnpm ls\fR, limiting output to only those packages that are linked.983.SS "\fBlocal-address\fR"984.RS 0985.IP \(bu 4986Default: null987.IP \(bu 4988Type: IP Address989.RE 0990 991.P992The 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.993.SS "\fBlocation\fR"994.RS 0995.IP \(bu 4996Default: "user" unless \fB--global\fR is passed, which will also set this value to "global"997.IP \(bu 4998Type: "global", "user", or "project"999.RE 01000 1001.P1002When passed to \fBnpm config\fR this refers to which config file to use.1003.P1004When set to "global" mode, packages are installed into the \fBprefix\fR folder instead of the current working directory. See npm help folders for more on the differences in behavior.1005.RS 01006.IP \(bu 41007packages are installed into the \fB{prefix}/lib/node_modules\fR folder, instead of the current working directory.1008.IP \(bu 41009bin files are linked to \fB{prefix}/bin\fR1010.IP \(bu 41011man pages are linked to \fB{prefix}/share/man\fR1012.RE 01013 1014.SS "\fBlockfile-version\fR"1015.RS 01016.IP \(bu 41017Default: Version 3 if no lockfile, auto-converting v1 lockfiles to v3; otherwise, maintain current lockfile version.1018.IP \(bu 41019Type: null, 1, 2, 3, "1", "2", or "3"1020.RE 01021 1022.P1023Set the lockfile format version to be used in package-lock.json and npm-shrinkwrap-json files. Possible options are:1024.P10251: The lockfile version used by npm versions 5 and 6. Lacks some data that is used during the install, resulting in slower and possibly less deterministic installs. Prevents lockfile churn when interoperating with older npm versions.1026.P10272: The default lockfile version used by npm version 7 and 8. Includes both the version 1 lockfile data and version 3 lockfile data, for maximum determinism and interoperability, at the expense of more bytes on disk.1028.P10293: Only the new lockfile information introduced in npm version 7. Smaller on disk than lockfile version 2, but not interoperable with older npm versions. Ideal if all users are on npm version 7 and higher.1030.SS "\fBloglevel\fR"1031.RS 01032.IP \(bu 41033Default: "notice"1034.IP \(bu 41035Type: "silent", "error", "warn", "notice", "http", "info", "verbose", or "silly"1036.RE 01037 1038.P1039What level of logs to report. All logs are written to a debug log, with the path to that file printed if the execution of a command fails.1040.P1041Any logs of a higher level than the setting are shown. The default is "notice".1042.P1043See also the \fBforeground-scripts\fR config.1044.SS "\fBlogs-dir\fR"1045.RS 01046.IP \(bu 41047Default: A directory named \fB_logs\fR inside the cache1048.IP \(bu 41049Type: null or Path1050.RE 01051 1052.P1053The location of npm's log directory. See npm help logging for more information.1054.SS "\fBlogs-max\fR"1055.RS 01056.IP \(bu 41057Default: 101058.IP \(bu 41059Type: Number1060.RE 01061 1062.P1063The maximum number of log files to store.1064.P1065If set to 0, no log files will be written for the current run.1066.SS "\fBlong\fR"1067.RS 01068.IP \(bu 41069Default: false1070.IP \(bu 41071Type: Boolean1072.RE 01073 1074.P1075Show extended information in \fBls\fR, \fBsearch\fR, and \fBhelp-search\fR.1076.SS "\fBmaxsockets\fR"1077.RS 01078.IP \(bu 41079Default: 151080.IP \(bu 41081Type: Number1082.RE 01083 1084.P1085The maximum number of connections to use per origin (protocol/host/port combination).1086.SS "\fBmessage\fR"1087.RS 01088.IP \(bu 41089Default: "%s"1090.IP \(bu 41091Type: String1092.RE 01093 1094.P1095Commit message which is used by \fBnpm version\fR when creating version commit.1096.P1097Any "%s" in the message will be replaced with the version number.1098.SS "\fBmin-release-age\fR"1099.RS 01100.IP \(bu 41101Default: null1102.IP \(bu 41103Type: null or Number1104.RE 01105 1106.P1107If set, npm will build the npm tree such that only versions that were available more than the given number of days ago will be installed. If there are no versions available for the current set of dependencies, the command will error.1108.P1109This flag is a complement to \fBbefore\fR, which accepts an exact date instead of a relative number of days.1110.P1111This config cannot be used with: \fBbefore\fR1112.SS "\fBname\fR"1113.RS 01114.IP \(bu 41115Default: null1116.IP \(bu 41117Type: null or String1118.RE 01119 1120.P1121When creating a Granular Access Token with \fBnpm token create\fR, this sets the name/description for the token.1122.SS "\fBnode-gyp\fR"1123.RS 01124.IP \(bu 41125Default: The path to the node-gyp bin that ships with npm1126.IP \(bu 41127Type: Path1128.RE 01129 1130.P1131This is the location of the "node-gyp" bin. By default it uses one that ships with npm itself.1132.P1133You can use this config to specify your own "node-gyp" to run when it is required to build a package.1134.SS "\fBnode-options\fR"1135.RS 01136.IP \(bu 41137Default: null1138.IP \(bu 41139Type: null or String1140.RE 01141 1142.P1143Options to pass through to Node.js via the \fBNODE_OPTIONS\fR environment variable. This does not impact how npm itself is executed but it does impact how lifecycle scripts are called.1144.SS "\fBnoproxy\fR"1145.RS 01146.IP \(bu 41147Default: The value of the NO_PROXY environment variable1148.IP \(bu 41149Type: String (can be set multiple times)1150.RE 01151 1152.P1153Domain extensions that should bypass any proxies.1154.P1155Also accepts a comma-delimited string.1156.SS "\fBoffline\fR"1157.RS 01158.IP \(bu 41159Default: false1160.IP \(bu 41161Type: Boolean1162.RE 01163 1164.P1165Force offline mode: no network requests will be done during install. To allow the CLI to fill in missing cache data, see \fB--prefer-offline\fR.1166.SS "\fBomit\fR"1167.RS 01168.IP \(bu 41169Default: 'dev' if the \fBNODE_ENV\fR environment variable is set to 'production'; otherwise, empty.1170.IP \(bu 41171Type: "dev", "optional", or "peer" (can be set multiple times)1172.RE 01173 1174.P1175Dependency types to omit from the installation tree on disk.1176.P1177Note that these dependencies \fIare\fR still resolved and added to the \fBpackage-lock.json\fR or \fBnpm-shrinkwrap.json\fR file. They are just not physically installed on disk.1178.P1179If a package type appears in both the \fB--include\fR and \fB--omit\fR lists, then it will be included.1180.P1181If the resulting omit list includes \fB'dev'\fR, then the \fBNODE_ENV\fR environment variable will be set to \fB'production'\fR for all lifecycle scripts.1182.SS "\fBomit-lockfile-registry-resolved\fR"1183.RS 01184.IP \(bu 41185Default: false1186.IP \(bu 41187Type: Boolean1188.RE 01189 1190.P1191This option causes npm to create lock files without a \fBresolved\fR key for registry dependencies. Subsequent installs will need to resolve tarball endpoints with the configured registry, likely resulting in a longer install time.1192.SS "\fBorgs\fR"1193.RS 01194.IP \(bu 41195Default: null1196.IP \(bu 41197Type: null or String (can be set multiple times)1198.RE 01199 1200.P1201When creating a Granular Access Token with \fBnpm token create\fR, this limits the token access to specific organizations.1202.SS "\fBorgs-permission\fR"1203.RS 01204.IP \(bu 41205Default: null1206.IP \(bu 41207Type: null, "read-only", "read-write", or "no-access"1208.RE 01209 1210.P1211When creating a Granular Access Token with \fBnpm token create\fR, sets the permission level for organizations. Options are "read-only", "read-write", or "no-access".1212.SS "\fBos\fR"1213.RS 01214.IP \(bu 41215Default: null1216.IP \(bu 41217Type: null or String1218.RE 01219 1220.P1221Override OS of native modules to install. Acceptable values are same as \fBos\fR field of package.json, which comes from \fBprocess.platform\fR.1222.SS "\fBotp\fR"1223.RS 01224.IP \(bu 41225Default: null1226.IP \(bu 41227Type: null or String1228.RE 01229 1230.P1231This is a one-time password from a two-factor authenticator. It's needed when publishing or changing package permissions with \fBnpm access\fR.1232.P1233If not set, and a registry response fails with a challenge for a one-time password, npm will prompt on the command line for one.1234.SS "\fBpack-destination\fR"1235.RS 01236.IP \(bu 41237Default: "."1238.IP \(bu 41239Type: String1240.RE 01241 1242.P1243Directory in which \fBnpm pack\fR will save tarballs.1244.SS "\fBpackage\fR"1245.RS 01246.IP \(bu 41247Default:1248.IP \(bu 41249Type: String (can be set multiple times)1250.RE 01251 1252.P1253The package or packages to install for npm help exec1254.SS "\fBpackage-lock\fR"1255.RS 01256.IP \(bu 41257Default: true1258.IP \(bu 41259Type: Boolean1260.RE 01261 1262.P1263If set to false, then ignore \fBpackage-lock.json\fR files when installing. This will also prevent \fIwriting\fR \fBpackage-lock.json\fR if \fBsave\fR is true.1264.SS "\fBpackage-lock-only\fR"1265.RS 01266.IP \(bu 41267Default: false1268.IP \(bu 41269Type: Boolean1270.RE 01271 1272.P1273If set to true, the current operation will only use the \fBpackage-lock.json\fR, ignoring \fBnode_modules\fR.1274.P1275For \fBupdate\fR this means only the \fBpackage-lock.json\fR will be updated, instead of checking \fBnode_modules\fR and downloading dependencies.1276.P1277For \fBlist\fR this means the output will be based on the tree described by the \fBpackage-lock.json\fR, rather than the contents of \fBnode_modules\fR.1278.SS "\fBpackages\fR"1279.RS 01280.IP \(bu 41281Default:1282.IP \(bu 41283Type: null or String (can be set multiple times)1284.RE 01285 1286.P1287When creating a Granular Access Token with \fBnpm token create\fR, this limits the token access to specific packages.1288.SS "\fBpackages-all\fR"1289.RS 01290.IP \(bu 41291Default: false1292.IP \(bu 41293Type: Boolean1294.RE 01295 1296.P1297When creating a Granular Access Token with \fBnpm token create\fR, grants the token access to all packages instead of limiting to specific packages.1298.SS "\fBpackages-and-scopes-permission\fR"1299.RS 01300.IP \(bu 41301Default: null1302.IP \(bu 41303Type: null, "read-only", "read-write", or "no-access"1304.RE 01305 1306.P1307When creating a Granular Access Token with \fBnpm token create\fR, sets the permission level for packages and scopes. Options are "read-only", "read-write", or "no-access".1308.SS "\fBparseable\fR"1309.RS 01310.IP \(bu 41311Default: false1312.IP \(bu 41313Type: Boolean1314.RE 01315 1316.P1317Output parseable results from commands that write to standard output. For \fBnpm search\fR, this will be tab-separated table format.1318.SS "\fBpassword\fR"1319.RS 01320.IP \(bu 41321Default: null1322.IP \(bu 41323Type: null or String1324.RE 01325 1326.P1327Password for authentication. Can be provided via command line when creating tokens, though it's generally safer to be prompted for it.1328.SS "\fBprefer-dedupe\fR"1329.RS 01330.IP \(bu 41331Default: false1332.IP \(bu 41333Type: Boolean1334.RE 01335 1336.P1337Prefer to deduplicate packages if possible, rather than choosing a newer version of a dependency.1338.SS "\fBprefer-offline\fR"1339.RS 01340.IP \(bu 41341Default: false1342.IP \(bu 41343Type: Boolean1344.RE 01345 1346.P1347If 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\fR.1348.SS "\fBprefer-online\fR"1349.RS 01350.IP \(bu 41351Default: false1352.IP \(bu 41353Type: Boolean1354.RE 01355 1356.P1357If true, staleness checks for cached data will be forced, making the CLI look for updates immediately even for fresh package data.1358.SS "\fBprefix\fR"1359.RS 01360.IP \(bu 41361Default: In global mode, the folder where the node executable is installed. Otherwise, the nearest parent folder containing either a package.json file or a node_modules folder.1362.IP \(bu 41363Type: Path1364.RE 01365 1366.P1367The location to install global items. If set on the command line, then it forces non-global commands to run in the specified folder.1368.SS "\fBpreid\fR"1369.RS 01370.IP \(bu 41371Default: ""1372.IP \(bu 41373Type: String1374.RE 01375 1376.P1377The "prerelease identifier" to use as a prefix for the "prerelease" part of a semver. Like the \fBrc\fR in \fB1.2.0-rc.8\fR.1378.SS "\fBprogress\fR"1379.RS 01380.IP \(bu 41381Default: \fBtrue\fR when not in CI and both stderr and stdout are TTYs and not in a dumb terminal1382.IP \(bu 41383Type: Boolean1384.RE 01385 1386.P1387When set to \fBtrue\fR, npm will display a progress bar during time intensive operations, if \fBprocess.stderr\fR and \fBprocess.stdout\fR are a TTY.1388.P1389Set to \fBfalse\fR to suppress the progress bar.1390.SS "\fBprovenance\fR"1391.RS 01392.IP \(bu 41393Default: false1394.IP \(bu 41395Type: Boolean1396.RE 01397 1398.P1399When publishing from a supported cloud CI/CD system, the package will be publicly linked to where it was built and published from.1400.P1401This config cannot be used with: \fBprovenance-file\fR1402.SS "\fBprovenance-file\fR"1403.RS 01404.IP \(bu 41405Default: null1406.IP \(bu 41407Type: Path1408.RE 01409 1410.P1411When publishing, the provenance bundle at the given path will be used.1412.P1413This config cannot be used with: \fBprovenance\fR1414.SS "\fBproxy\fR"1415.RS 01416.IP \(bu 41417Default: null1418.IP \(bu 41419Type: null, false, or URL1420.RE 01421 1422.P1423A proxy to use for outgoing http requests. If the \fBHTTP_PROXY\fR or \fBhttp_proxy\fR environment variables are set, proxy settings will be honored by the underlying \fBrequest\fR library.1424.SS "\fBread-only\fR"1425.RS 01426.IP \(bu 41427Default: false1428.IP \(bu 41429Type: Boolean1430.RE 01431 1432.P1433This is used to mark a token as unable to publish when configuring limited access tokens with the \fBnpm token create\fR command.1434.SS "\fBrebuild-bundle\fR"1435.RS 01436.IP \(bu 41437Default: true1438.IP \(bu 41439Type: Boolean1440.RE 01441 1442.P1443Rebuild bundled dependencies after installation.1444.SS "\fBregistry\fR"1445.RS 01446.IP \(bu 41447Default: "https://registry.npmjs.org/"1448.IP \(bu 41449Type: URL1450.RE 01451 1452.P1453The base URL of the npm registry.1454.SS "\fBreplace-registry-host\fR"1455.RS 01456.IP \(bu 41457Default: "npmjs"1458.IP \(bu 41459Type: "npmjs", "never", "always", or String1460.RE 01461 1462.P1463Defines behavior for replacing the registry host in a lockfile with the configured registry.1464.P1465The default behavior is to replace package dist URLs from the default registry (https://registry.npmjs.org) to the configured registry. If set to "never", then use the registry value. If set to "always", then replace the registry host with the configured host every time.1466.P1467You may also specify a bare hostname (e.g., "registry.npmjs.org").1468.SS "\fBsave\fR"1469.RS 01470.IP \(bu 41471Default: \fBtrue\fR unless when using \fBnpm update\fR where it defaults to \fBfalse\fR1472.IP \(bu 41473Type: Boolean1474.RE 01475 1476.P1477Save installed packages to a \fBpackage.json\fR file as dependencies.1478.P1479When used with the \fBnpm rm\fR command, removes the dependency from \fBpackage.json\fR.1480.P1481Will also prevent writing to \fBpackage-lock.json\fR if set to \fBfalse\fR.1482.SS "\fBsave-bundle\fR"1483.RS 01484.IP \(bu 41485Default: false1486.IP \(bu 41487Type: Boolean1488.RE 01489 1490.P1491If a package would be saved at install time by the use of \fB--save\fR, \fB--save-dev\fR, or \fB--save-optional\fR, then also put it in the \fBbundleDependencies\fR list.1492.P1493Ignored if \fB--save-peer\fR is set, since peerDependencies cannot be bundled.1494.SS "\fBsave-dev\fR"1495.RS 01496.IP \(bu 41497Default: false1498.IP \(bu 41499Type: Boolean1500.RE 01501 1502.P1503Save installed packages to a package.json file as \fBdevDependencies\fR.1504.P1505This config cannot be used with: \fBsave-optional\fR, \fBsave-peer\fR, \fBsave-prod\fR1506.SS "\fBsave-exact\fR"1507.RS 01508.IP \(bu 41509Default: false1510.IP \(bu 41511Type: Boolean1512.RE 01513 1514.P1515Dependencies saved to package.json will be configured with an exact version rather than using npm's default semver range operator.1516.SS "\fBsave-optional\fR"1517.RS 01518.IP \(bu 41519Default: false1520.IP \(bu 41521Type: Boolean1522.RE 01523 1524.P1525Save installed packages to a package.json file as \fBoptionalDependencies\fR.1526.P1527This config cannot be used with: \fBsave-dev\fR, \fBsave-peer\fR, \fBsave-prod\fR1528.SS "\fBsave-peer\fR"1529.RS 01530.IP \(bu 41531Default: false1532.IP \(bu 41533Type: Boolean1534.RE 01535 1536.P1537Save installed packages to a package.json file as \fBpeerDependencies\fR1538.P1539This config cannot be used with: \fBsave-dev\fR, \fBsave-optional\fR, \fBsave-prod\fR1540.SS "\fBsave-prefix\fR"1541.RS 01542.IP \(bu 41543Default: "^"1544.IP \(bu 41545Type: String1546.RE 01547 1548.P1549Configure how versions of packages installed to a package.json file via \fB--save\fR or \fB--save-dev\fR get prefixed.1550.P1551For example if a package has version \fB1.2.3\fR, by default its version is set to \fB^1.2.3\fR which allows minor upgrades for that package, but after \fBnpm1552config set save-prefix='~'\fR it would be set to \fB~1.2.3\fR which only allows patch upgrades.1553.SS "\fBsave-prod\fR"1554.RS 01555.IP \(bu 41556Default: false1557.IP \(bu 41558Type: Boolean1559.RE 01560 1561.P1562Save installed packages into \fBdependencies\fR specifically. This is useful if a package already exists in \fBdevDependencies\fR or \fBoptionalDependencies\fR, but you want to move it to be a non-optional production dependency.1563.P1564This is the default behavior if \fB--save\fR is true, and neither \fB--save-dev\fR or \fB--save-optional\fR are true.1565.P1566This config cannot be used with: \fBsave-dev\fR, \fBsave-optional\fR, \fBsave-peer\fR1567.SS "\fBsbom-format\fR"1568.RS 01569.IP \(bu 41570Default: null1571.IP \(bu 41572Type: "cyclonedx" or "spdx"1573.RE 01574 1575.P1576SBOM format to use when generating SBOMs.1577.SS "\fBsbom-type\fR"1578.RS 01579.IP \(bu 41580Default: "library"1581.IP \(bu 41582Type: "library", "application", or "framework"1583.RE 01584 1585.P1586The type of package described by the generated SBOM. For SPDX, this is the value for the \fBprimaryPackagePurpose\fR field. For CycloneDX, this is the value for the \fBtype\fR field.1587.SS "\fBscope\fR"1588.RS 01589.IP \(bu 41590Default: the scope of the current project, if any, or ""1591.IP \(bu 41592Type: String1593.RE 01594 1595.P1596Associate an operation with a scope for a scoped registry.1597.P1598Useful when logging in to or out of a private registry:1599.P1600.RS 21601.nf1602# log in, linking the scope to the custom registry1603npm login --scope=@mycorp --registry=https://registry.mycorp.com1604 1605# log out, removing the link and the auth token1606npm logout --scope=@mycorp1607.fi1608.RE1609.P1610This will cause \fB@mycorp\fR to be mapped to the registry for future installation of packages specified according to the pattern \fB@mycorp/package\fR.1611.P1612This will also cause \fBnpm init\fR to create a scoped package.1613.P1614.RS 21615.nf1616# accept all defaults, and create a package named "@foo/whatever",1617# instead of just named "whatever"1618npm init --scope=@foo --yes1619.fi1620.RE1621.SS "\fBscopes\fR"1622.RS 01623.IP \(bu 41624Default: null1625.IP \(bu 41626Type: null or String (can be set multiple times)1627.RE 01628 1629.P1630When creating a Granular Access Token with \fBnpm token create\fR, this limits the token access to specific scopes. Provide a scope name (with or without @ prefix).1631.SS "\fBscript-shell\fR"1632.RS 01633.IP \(bu 41634Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows1635.IP \(bu 41636Type: null or String1637.RE 01638 1639.P1640The shell to use for scripts run with the \fBnpm exec\fR, \fBnpm run\fR and \fBnpm1641init <package-spec>\fR commands.1642.SS "\fBsearchexclude\fR"1643.RS 01644.IP \(bu 41645Default: ""1646.IP \(bu 41647Type: String1648.RE 01649 1650.P1651Space-separated options that limit the results from search.1652.SS "\fBsearchlimit\fR"1653.RS 01654.IP \(bu 41655Default: 201656.IP \(bu 41657Type: Number1658.RE 01659 1660.P1661Number of items to limit search results to. Will not apply at all to legacy searches.1662.SS "\fBsearchopts\fR"1663.RS 01664.IP \(bu 41665Default: ""1666.IP \(bu 41667Type: String1668.RE 01669 1670.P1671Space-separated options that are always passed to search.1672.SS "\fBsearchstaleness\fR"1673.RS 01674.IP \(bu 41675Default: 9001676.IP \(bu 41677Type: Number1678.RE 01679 1680.P1681The age of the cache, in seconds, before another registry request is made if using legacy search endpoint.1682.SS "\fBshell\fR"1683.RS 01684.IP \(bu 41685Default: SHELL environment variable, or "bash" on Posix, or "cmd.exe" on Windows1686.IP \(bu 41687Type: String1688.RE 01689 1690.P1691The shell to run for the \fBnpm explore\fR command.1692.SS "\fBsign-git-commit\fR"1693.RS 01694.IP \(bu 41695Default: false1696.IP \(bu 41697Type: Boolean1698.RE 01699 1700.P1701If set to true, then the \fBnpm version\fR command will commit the new package version using \fB-S\fR to add a signature.1702.P1703Note that git requires you to have set up GPG keys in your git configs for this to work properly.1704.SS "\fBsign-git-tag\fR"1705.RS 01706.IP \(bu 41707Default: false1708.IP \(bu 41709Type: Boolean1710.RE 01711 1712.P1713If set to true, then the \fBnpm version\fR command will tag the version using \fB-s\fR to add a signature.1714.P1715Note that git requires you to have set up GPG keys in your git configs for this to work properly.1716.SS "\fBstrict-peer-deps\fR"1717.RS 01718.IP \(bu 41719Default: false1720.IP \(bu 41721Type: Boolean1722.RE 01723 1724.P1725If set to \fBtrue\fR, and \fB--legacy-peer-deps\fR is not set, then \fIany\fR conflicting \fBpeerDependencies\fR will be treated as an install failure, even if npm could reasonably guess the appropriate resolution based on non-peer dependency relationships.1726.P1727By default, conflicting \fBpeerDependencies\fR deep in the dependency graph will be resolved using the nearest non-peer dependency specification, even if doing so will result in some packages receiving a peer dependency outside the range set in their package's \fBpeerDependencies\fR object.1728.P1729When such an override is performed, a warning is printed, explaining the conflict and the packages involved. If \fB--strict-peer-deps\fR is set, then this warning is treated as a failure.1730.SS "\fBstrict-ssl\fR"1731.RS 01732.IP \(bu 41733Default: true1734.IP \(bu 41735Type: Boolean1736.RE 01737 1738.P1739Whether or not to do SSL key validation when making requests to the registry via https.1740.P1741See also the \fBca\fR config.1742.SS "\fBtag\fR"1743.RS 01744.IP \(bu 41745Default: "latest"1746.IP \(bu 41747Type: String1748.RE 01749 1750.P1751If you ask npm to install a package and don't tell it a specific version, then it will install the specified tag.1752.P1753It is the tag added to the package@version specified in the \fBnpm dist-tag1754add\fR command, if no explicit tag is given.1755.P1756When used by the \fBnpm diff\fR command, this is the tag used to fetch the tarball that will be compared with the local files by default.1757.P1758If used in the \fBnpm publish\fR command, this is the tag that will be added to the package submitted to the registry.1759.SS "\fBtag-version-prefix\fR"1760.RS 01761.IP \(bu 41762Default: "v"1763.IP \(bu 41764Type: String1765.RE 01766 1767.P1768If set, alters the prefix used when tagging a new version when performing a version increment using \fBnpm version\fR. To remove the prefix altogether, set it to the empty string: \fB""\fR.1769.P1770Because other tools may rely on the convention that npm version tags look like \fBv1.0.0\fR, \fIonly use this property if it is absolutely necessary\fR. In particular, use care when overriding this setting for public packages.1771.SS "\fBtiming\fR"1772.RS 01773.IP \(bu 41774Default: false1775.IP \(bu 41776Type: Boolean1777.RE 01778 1779.P1780If true, writes timing information to a process specific json file in the cache or \fBlogs-dir\fR. The file name ends with \fB-timing.json\fR.1781.P1782You can quickly view it with this \fBjson\fR \fI\(lahttps://npm.im/json\(ra\fR command line: \fBcat ~/.npm/_logs/*-timing.json | npm exec -- json -g\fR.1783.P1784Timing information will also be reported in the terminal. To suppress this while still writing the timing file, use \fB--silent\fR.1785.SS "\fBtoken-description\fR"1786.RS 01787.IP \(bu 41788Default: null1789.IP \(bu 41790Type: null or String1791.RE 01792 1793.P1794Description text for the token when using \fBnpm token create\fR.1795.SS "\fBumask\fR"1796.RS 01797.IP \(bu 41798Default: 01799.IP \(bu 41800Type: Octal numeric string in range 0000..0777 (0..511)1801.RE 01802 1803.P1804The "umask" value to use when setting the file creation mode on files and folders.1805.P1806Folders and executables are given a mode which is \fB0o777\fR masked against this value. Other files are given a mode which is \fB0o666\fR masked against this value.1807.P1808Note that the underlying system will \fIalso\fR apply its own umask value to files and folders that are created, and npm does not circumvent this, but rather adds the \fB--umask\fR config to it.1809.P1810Thus, 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.1811.SS "\fBunicode\fR"1812.RS 01813.IP \(bu 41814Default: false on windows, true on mac/unix systems with a unicode locale, as defined by the \fBLC_ALL\fR, \fBLC_CTYPE\fR, or \fBLANG\fR environment variables.1815.IP \(bu 41816Type: Boolean1817.RE 01818 1819.P1820When set to true, npm uses unicode characters in the tree output. When false, it uses ascii characters instead of unicode glyphs.1821.SS "\fBupdate-notifier\fR"1822.RS 01823.IP \(bu 41824Default: true1825.IP \(bu 41826Type: Boolean1827.RE 01828 1829.P1830Set to false to suppress the update notification when using an older version of npm than the latest.1831.SS "\fBusage\fR"1832.RS 01833.IP \(bu 41834Default: false1835.IP \(bu 41836Type: Boolean1837.RE 01838 1839.P1840Show short usage output about the command specified.1841.SS "\fBuser-agent\fR"1842.RS 01843.IP \(bu 41844Default: "npm/{npm-version} node/{node-version} {platform} {arch} workspaces/{workspaces} {ci}"1845.IP \(bu 41846Type: String1847.RE 01848 1849.P1850Sets the User-Agent request header. The following fields are replaced with their actual counterparts:1851.RS 01852.IP \(bu 41853\fB{npm-version}\fR - The npm version in use1854.IP \(bu 41855\fB{node-version}\fR - The Node.js version in use1856.IP \(bu 41857\fB{platform}\fR - The value of \fBprocess.platform\fR1858.IP \(bu 41859\fB{arch}\fR - The value of \fBprocess.arch\fR1860.IP \(bu 41861\fB{workspaces}\fR - Set to \fBtrue\fR if the \fBworkspaces\fR or \fBworkspace\fR options are set.1862.IP \(bu 41863\fB{ci}\fR - The value of the \fBci-name\fR config, if set, prefixed with \fBci/\fR, or an empty string if \fBci-name\fR is empty.1864.RE 01865 1866.SS "\fBuserconfig\fR"1867.RS 01868.IP \(bu 41869Default: "~/.npmrc"1870.IP \(bu 41871Type: Path1872.RE 01873 1874.P1875The location of user-level configuration settings.1876.P1877This may be overridden by the \fBnpm_config_userconfig\fR environment variable or the \fB--userconfig\fR command line option, but may \fInot\fR be overridden by settings in the \fBglobalconfig\fR file.1878.SS "\fBversion\fR"1879.RS 01880.IP \(bu 41881Default: false1882.IP \(bu 41883Type: Boolean1884.RE 01885 1886.P1887If true, output the npm version and exit successfully.1888.P1889Only relevant when specified explicitly on the command line.1890.SS "\fBversions\fR"1891.RS 01892.IP \(bu 41893Default: false1894.IP \(bu 41895Type: Boolean1896.RE 01897 1898.P1899If true, output the npm version as well as node's \fBprocess.versions\fR map and the version in the current working directory's \fBpackage.json\fR file if one exists, and exit successfully.1900.P1901Only relevant when specified explicitly on the command line.1902.SS "\fBviewer\fR"1903.RS 01904.IP \(bu 41905Default: "man" on Posix, "browser" on Windows1906.IP \(bu 41907Type: String1908.RE 01909 1910.P1911The program to use to view help content.1912.P1913Set to \fB"browser"\fR to view html help content in the default web browser.1914.SS "\fBwhich\fR"1915.RS 01916.IP \(bu 41917Default: null1918.IP \(bu 41919Type: null or Number1920.RE 01921 1922.P1923If there are multiple funding sources, which 1-indexed source URL to open.1924.SS "\fBworkspace\fR"1925.RS 01926.IP \(bu 41927Default:1928.IP \(bu 41929Type: String (can be set multiple times)1930.RE 01931 1932.P1933Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option.1934.P1935Valid values for the \fBworkspace\fR config are either:1936.RS 01937.IP \(bu 41938Workspace names1939.IP \(bu 41940Path to a workspace directory1941.IP \(bu 41942Path to a parent workspace directory (will result in selecting all workspaces within that folder)1943.RE 01944 1945.P1946When set for the \fBnpm init\fR command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.1947.P1948This value is not exported to the environment for child processes.1949.SS "\fBworkspaces\fR"1950.RS 01951.IP \(bu 41952Default: null1953.IP \(bu 41954Type: null or Boolean1955.RE 01956 1957.P1958Set to true to run the command in the context of \fBall\fR configured workspaces.1959.P1960Explicitly setting this to false will cause commands like \fBinstall\fR to ignore workspaces altogether. When not set explicitly:1961.RS 01962.IP \(bu 41963Commands that operate on the \fBnode_modules\fR tree (install, update, etc.) will link workspaces into the \fBnode_modules\fR folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project, \fIunless\fR one or more workspaces are specified in the \fBworkspace\fR config.1964.RE 01965 1966.P1967This value is not exported to the environment for child processes.1968.SS "\fBworkspaces-update\fR"1969.RS 01970.IP \(bu 41971Default: true1972.IP \(bu 41973Type: Boolean1974.RE 01975 1976.P1977If set to true, the npm cli will run an update after operations that may possibly change the workspaces installed to the \fBnode_modules\fR folder.1978.SS "\fByes\fR"1979.RS 01980.IP \(bu 41981Default: null1982.IP \(bu 41983Type: null or Boolean1984.RE 01985 1986.P1987Automatically answer "yes" to any prompts that npm might print on the command line.1988.SS "\fBalso\fR"1989.RS 01990.IP \(bu 41991Default: null1992.IP \(bu 41993Type: null, "dev", or "development"1994.IP \(bu 41995DEPRECATED: Please use --include=dev instead.1996.RE 01997 1998.P1999When set to \fBdev\fR or \fBdevelopment\fR, this is an alias for \fB--include=dev\fR.2000.SS "\fBcache-max\fR"2001.RS 02002.IP \(bu 42003Default: Infinity2004.IP \(bu 42005Type: Number2006.IP \(bu 42007DEPRECATED: This option has been deprecated in favor of \fB--prefer-online\fR2008.RE 02009 2010.P2011\fB--cache-max=0\fR is an alias for \fB--prefer-online\fR2012.SS "\fBcache-min\fR"2013.RS 02014.IP \(bu 42015Default: 02016.IP \(bu 42017Type: Number2018.IP \(bu 42019DEPRECATED: This option has been deprecated in favor of \fB--prefer-offline\fR.2020.RE 02021 2022.P2023\fB--cache-min=9999 (or bigger)\fR is an alias for \fB--prefer-offline\fR.2024.SS "\fBcert\fR"2025.RS 02026.IP \(bu 42027Default: null2028.IP \(bu 42029Type: null or String2030.IP \(bu 42031DEPRECATED: \fBkey\fR and \fBcert\fR are no longer used for most registry operations. Use registry scoped \fBkeyfile\fR and \fBcertfile\fR instead. Example: //other-registry.tld/:keyfile=/path/to/key.pem //other-registry.tld/:certfile=/path/to/cert.crt2032.RE 02033 2034.P2035A client certificate to pass when accessing the registry. Values should be in PEM format (Windows calls it "Base-64 encoded X.509 (.CER)") with newlines replaced by the string "\[rs]n". For example:2036.P2037.RS 22038.nf2039cert="-----BEGIN CERTIFICATE-----\[rs]nXXXX\[rs]nXXXX\[rs]n-----END CERTIFICATE-----"2040.fi2041.RE2042.P2043It is \fInot\fR the path to a certificate file, though you can set a registry-scoped "certfile" path like "//other-registry.tld/:certfile=/path/to/cert.pem".2044.SS "\fBdev\fR"2045.RS 02046.IP \(bu 42047Default: false2048.IP \(bu 42049Type: Boolean2050.IP \(bu 42051DEPRECATED: Please use --include=dev instead.2052.RE 02053 2054.P2055Alias for \fB--include=dev\fR.2056.SS "\fBglobal-style\fR"2057.RS 02058.IP \(bu 42059Default: false2060.IP \(bu 42061Type: Boolean2062.IP \(bu 42063DEPRECATED: This option has been deprecated in favor of \fB--install-strategy=shallow\fR2064.RE 02065 2066.P2067Only install direct dependencies in the top level \fBnode_modules\fR, but hoist on deeper dependencies. Sets \fB--install-strategy=shallow\fR.2068.SS "\fBinit.author.email\fR"2069.RS 02070.IP \(bu 42071Default: ""2072.IP \(bu 42073Type: String2074.IP \(bu 42075DEPRECATED: Use \fB--init-author-email\fR instead.2076.RE 02077 2078.P2079Alias for \fB--init-author-email\fR2080.SS "\fBinit.author.name\fR"2081.RS 02082.IP \(bu 42083Default: ""2084.IP \(bu 42085Type: String2086.IP \(bu 42087DEPRECATED: Use \fB--init-author-name\fR instead.2088.RE 02089 2090.P2091Alias for \fB--init-author-name\fR2092.SS "\fBinit.author.url\fR"2093.RS 02094.IP \(bu 42095Default: ""2096.IP \(bu 42097Type: "" or URL2098.IP \(bu 42099DEPRECATED: Use \fB--init-author-url\fR instead.2100.RE 02101 2102.P2103Alias for \fB--init-author-url\fR2104.SS "\fBinit.license\fR"2105.RS 02106.IP \(bu 42107Default: "ISC"2108.IP \(bu 42109Type: String2110.IP \(bu 42111DEPRECATED: Use \fB--init-license\fR instead.2112.RE 02113 2114.P2115Alias for \fB--init-license\fR2116.SS "\fBinit.module\fR"2117.RS 02118.IP \(bu 42119Default: "~/.npm-init.js"2120.IP \(bu 42121Type: Path2122.IP \(bu 42123DEPRECATED: Use \fB--init-module\fR instead.2124.RE 02125 2126.P2127Alias for \fB--init-module\fR2128.SS "\fBinit.version\fR"2129.RS 02130.IP \(bu 42131Default: "1.0.0"2132.IP \(bu 42133Type: SemVer string2134.IP \(bu 42135DEPRECATED: Use \fB--init-version\fR instead.2136.RE 02137 2138.P2139Alias for \fB--init-version\fR2140.SS "\fBkey\fR"2141.RS 02142.IP \(bu 42143Default: null2144.IP \(bu 42145Type: null or String2146.IP \(bu 42147DEPRECATED: \fBkey\fR and \fBcert\fR are no longer used for most registry operations. Use registry scoped \fBkeyfile\fR and \fBcertfile\fR instead. Example: //other-registry.tld/:keyfile=/path/to/key.pem //other-registry.tld/:certfile=/path/to/cert.crt2148.RE 02149 2150.P2151A client key to pass when accessing the registry. Values should be in PEM format with newlines replaced by the string "\[rs]n". For example:2152.P2153.RS 22154.nf2155key="-----BEGIN PRIVATE KEY-----\[rs]nXXXX\[rs]nXXXX\[rs]n-----END PRIVATE KEY-----"2156.fi2157.RE2158.P2159It is \fInot\fR the path to a key file, though you can set a registry-scoped "keyfile" path like "//other-registry.tld/:keyfile=/path/to/key.pem".2160.SS "\fBlegacy-bundling\fR"2161.RS 02162.IP \(bu 42163Default: false2164.IP \(bu 42165Type: Boolean2166.IP \(bu 42167DEPRECATED: This option has been deprecated in favor of \fB--install-strategy=nested\fR2168.RE 02169 2170.P2171Instead of hoisting package installs in \fBnode_modules\fR, install packages in the same manner that they are depended on. This may cause very deep directory structures and duplicate package installs as there is no de-duplicating. Sets \fB--install-strategy=nested\fR.2172.SS "\fBonly\fR"2173.RS 02174.IP \(bu 42175Default: null2176.IP \(bu 42177Type: null, "prod", or "production"2178.IP \(bu 42179DEPRECATED: Use \fB--omit=dev\fR to omit dev dependencies from the install.2180.RE 02181 2182.P2183When set to \fBprod\fR or \fBproduction\fR, this is an alias for \fB--omit=dev\fR.2184.SS "\fBoptional\fR"2185.RS 02186.IP \(bu 42187Default: null2188.IP \(bu 42189Type: null or Boolean2190.IP \(bu 42191DEPRECATED: Use \fB--omit=optional\fR to exclude optional dependencies, or \fB--include=optional\fR to include them.2192.RE 02193 2194.P2195Default value does install optional deps unless otherwise omitted.2196.P2197Alias for --include=optional or --omit=optional2198.SS "\fBproduction\fR"2199.RS 02200.IP \(bu 42201Default: null2202.IP \(bu 42203Type: null or Boolean2204.IP \(bu 42205DEPRECATED: Use \fB--omit=dev\fR instead.2206.RE 02207 2208.P2209Alias for \fB--omit=dev\fR2210.SS "\fBshrinkwrap\fR"2211.RS 02212.IP \(bu 42213Default: true2214.IP \(bu 42215Type: Boolean2216.IP \(bu 42217DEPRECATED: Use the --package-lock setting instead.2218.RE 02219 2220.P2221Alias for --package-lock2222.SS "See also"2223.RS 02224.IP \(bu 42225npm help config2226.IP \(bu 42227npm help npmrc2228.IP \(bu 42229npm help scripts2230.IP \(bu 42231npm help folders2232.IP \(bu 42233npm help npm2234.RE 02235