893 lines
19 KiB
Groff
893 lines
19 KiB
Groff
|
.P
|
||
|
"
|
||
|
```
|
||
|
.P
|
||
|
It is \fInot\fR the path to a key file (and there is no "keyfile" option)\.
|
||
|
.SS legacy\-bundling
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Causes npm to install the package such that versions of npm prior to 1\.4,
|
||
|
such as the one included with node 0\.8, can install the package\. This
|
||
|
eliminates all automatic deduping\. If used with \fBglobal\-style\fP this option
|
||
|
will be preferred\.
|
||
|
.SS link
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
If true, then local installs will link if there is a suitable globally
|
||
|
installed package\.
|
||
|
.P
|
||
|
Note that this means that local installs can cause things to be
|
||
|
installed into the global space at the same time\. The link is only done
|
||
|
if one of the two conditions are met:
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
The package is not already installed globally, or
|
||
|
.IP \(bu 2
|
||
|
the globally installed version is identical to the version that is
|
||
|
being installed locally\.
|
||
|
|
||
|
.RE
|
||
|
.SS local\-address
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: undefined
|
||
|
.IP \(bu 2
|
||
|
Type: IP Address
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
The IP address of the local interface to use when making connections
|
||
|
to the npm registry\. Must be IPv4 in versions of Node prior to 0\.12\.
|
||
|
.SS loglevel
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: "notice"
|
||
|
.IP \(bu 2
|
||
|
Type: String
|
||
|
.IP \(bu 2
|
||
|
Values: "silent", "error", "warn", "notice", "http", "timing", "info",
|
||
|
"verbose", "silly"
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
What level of logs to report\. On failure, \fIall\fR logs are written to
|
||
|
\fBnpm\-debug\.log\fP in the current working directory\.
|
||
|
.P
|
||
|
Any logs of a higher level than the setting are shown\. The default is "notice"\.
|
||
|
.SS logstream
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: process\.stderr
|
||
|
.IP \(bu 2
|
||
|
Type: Stream
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
This is the stream that is passed to the
|
||
|
npmlog \fIhttps://github\.com/npm/npmlog\fR module at run time\.
|
||
|
.P
|
||
|
It cannot be set from the command line, but if you are using npm
|
||
|
programmatically, you may wish to send logs to somewhere other than
|
||
|
stderr\.
|
||
|
.P
|
||
|
If the \fBcolor\fP config is set to true, then this stream will receive
|
||
|
colored output if it is a TTY\.
|
||
|
.SS logs\-max
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: 10
|
||
|
.IP \(bu 2
|
||
|
Type: Number
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
The maximum number of log files to store\.
|
||
|
.SS long
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Show extended information in \fBnpm ls\fP and \fBnpm search\fP\|\.
|
||
|
.SS maxsockets
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: 50
|
||
|
.IP \(bu 2
|
||
|
Type: Number
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
The maximum number of connections to use per origin (protocol/host/port
|
||
|
combination)\. Passed to the \fBhttp\fP \fBAgent\fP used to make the request\.
|
||
|
.SS message
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: "%s"
|
||
|
.IP \(bu 2
|
||
|
Type: String
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Commit message which is used by \fBnpm version\fP when creating version commit\.
|
||
|
.P
|
||
|
Any "%s" in the message will be replaced with the version number\.
|
||
|
.SS metrics\-registry
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: The value of \fBregistry\fP (which defaults to "https://registry\.npmjs\.org/")
|
||
|
.IP \(bu 2
|
||
|
Type: String
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
The registry you want to send cli metrics to if \fBsend\-metrics\fP is true\.
|
||
|
.SS node\-options
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: null
|
||
|
.IP \(bu 2
|
||
|
Type: String
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Options to pass through to Node\.js via the \fBNODE_OPTIONS\fP environment
|
||
|
variable\. This does not impact how npm itself is executed but it does
|
||
|
impact how lifecycle scripts are called\.
|
||
|
.SS node\-version
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: process\.version
|
||
|
.IP \(bu 2
|
||
|
Type: semver or false
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
The node version to use when checking a package's \fBengines\fP map\.
|
||
|
.SS noproxy
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: null
|
||
|
.IP \(bu 2
|
||
|
Type: String or Array
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
A comma\-separated string or an array of domain extensions that a proxy should not be used for\.
|
||
|
.SS offline
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Force offline mode: no network requests will be done during install\. To allow
|
||
|
the CLI to fill in missing cache data, see \fB\-\-prefer\-offline\fP\|\.
|
||
|
.SS onload\-script
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: path
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
A node module to \fBrequire()\fP when npm loads\. Useful for programmatic
|
||
|
usage\.
|
||
|
.SS only
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: null
|
||
|
.IP \(bu 2
|
||
|
Type: String
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
When "dev" or "development" and running local \fBnpm install\fP without any
|
||
|
arguments, only devDependencies (and their dependencies) are installed\.
|
||
|
.P
|
||
|
When "dev" or "development" and running local \fBnpm ls\fP, \fBnpm outdated\fP, or
|
||
|
\fBnpm update\fP, is an alias for \fB\-\-dev\fP\|\.
|
||
|
.P
|
||
|
When "prod" or "production" and running local \fBnpm install\fP without any
|
||
|
arguments, only non\-devDependencies (and their dependencies) are
|
||
|
installed\.
|
||
|
.P
|
||
|
When "prod" or "production" and running local \fBnpm ls\fP, \fBnpm outdated\fP, or
|
||
|
\fBnpm update\fP, is an alias for \fB\-\-production\fP\|\.
|
||
|
.SS optional
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: true
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Attempt to install packages in the \fBoptionalDependencies\fP object\. Note
|
||
|
that if these packages fail to install, the overall installation
|
||
|
process is not aborted\.
|
||
|
.SS otp
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: null
|
||
|
.IP \(bu 2
|
||
|
Type: Number
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
This is a one\-time password from a two\-factor authenticator\. It's needed
|
||
|
when publishing or changing package permissions with \fBnpm access\fP\|\.
|
||
|
.SS package\-lock
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: true
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
If set to false, then ignore \fBpackage\-lock\.json\fP files when installing\. This
|
||
|
will also prevent \fIwriting\fR \fBpackage\-lock\.json\fP if \fBsave\fP is true\.
|
||
|
.P
|
||
|
When package package\-locks are disabled, automatic pruning of extraneous
|
||
|
modules will also be disabled\. To remove extraneous modules with
|
||
|
package\-locks disabled use \fBnpm prune\fP\|\.
|
||
|
.P
|
||
|
This option is an alias for \fB\-\-shrinkwrap\fP\|\.
|
||
|
.SS package\-lock\-only
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
If set to true, it will update only the \fBpackage\-lock\.json\fP,
|
||
|
instead of checking \fBnode_modules\fP and downloading dependencies\.
|
||
|
.SS parseable
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Output parseable results from commands that write to
|
||
|
standard output\. For \fBnpm search\fP, this will be tab\-separated table format\.
|
||
|
.SS prefer\-offline
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
If true, staleness checks for cached data will be bypassed, but missing data
|
||
|
will be requested from the server\. To force full offline mode, use \fB\-\-offline\fP\|\.
|
||
|
.P
|
||
|
This option is effectively equivalent to \fB\-\-cache\-min=9999999\fP\|\.
|
||
|
.SS prefer\-online
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
If true, staleness checks for cached data will be forced, making the CLI look
|
||
|
for updates immediately even for fresh package data\.
|
||
|
.SS prefix
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: see npm help folders
|
||
|
.IP \(bu 2
|
||
|
Type: path
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
The location to install global items\. If set on the command line, then
|
||
|
it forces non\-global commands to run in the specified folder\.
|
||
|
.SS preid
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: ""
|
||
|
.IP \(bu 2
|
||
|
Type: String
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
The "prerelease identifier" to use as a prefix for the "prerelease" part of a
|
||
|
semver\. Like the \fBrc\fP in \fB1\.2\.0\-rc\.8\fP\|\.
|
||
|
.SS production
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Set to true to run in "production" mode\.
|
||
|
.RS 0
|
||
|
.IP 1. 3
|
||
|
devDependencies are not installed at the topmost level when running
|
||
|
local \fBnpm install\fP without any arguments\.
|
||
|
.IP 2. 3
|
||
|
Set the NODE_ENV="production" for lifecycle scripts\.
|
||
|
|
||
|
.RE
|
||
|
.SS progress
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: true, unless TRAVIS or CI env vars set\.
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
When set to \fBtrue\fP, npm will display a progress bar during time intensive
|
||
|
operations, if \fBprocess\.stderr\fP is a TTY\.
|
||
|
.P
|
||
|
Set to \fBfalse\fP to suppress the progress bar\.
|
||
|
.SS proxy
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: null
|
||
|
.IP \(bu 2
|
||
|
Type: url
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
A proxy to use for outgoing http requests\. If the \fBHTTP_PROXY\fP or
|
||
|
\fBhttp_proxy\fP environment variables are set, proxy settings will be
|
||
|
honored by the underlying \fBrequest\fP library\.
|
||
|
.SS read\-only
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
This is used to mark a token as unable to publish when configuring limited access tokens with the \fBnpm token create\fP command\.
|
||
|
.SS rebuild\-bundle
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: true
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Rebuild bundled dependencies after installation\.
|
||
|
.SS registry
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: https://registry\.npmjs\.org/
|
||
|
.IP \(bu 2
|
||
|
Type: url
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
The base URL of the npm package registry\.
|
||
|
.SS rollback
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: true
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Remove failed installs\.
|
||
|
.SS save
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: true
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Save installed packages to a package\.json file as dependencies\.
|
||
|
.P
|
||
|
When used with the \fBnpm rm\fP command, it removes it from the \fBdependencies\fP
|
||
|
object\.
|
||
|
.P
|
||
|
Only works if there is already a package\.json file present\.
|
||
|
.SS save\-bundle
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
If a package would be saved at install time by the use of \fB\-\-save\fP,
|
||
|
\fB\-\-save\-dev\fP, or \fB\-\-save\-optional\fP, then also put it in the
|
||
|
\fBbundleDependencies\fP list\.
|
||
|
.P
|
||
|
When used with the \fBnpm rm\fP command, it removes it from the
|
||
|
bundledDependencies list\.
|
||
|
.SS save\-prod
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Makes sure that a package will be saved into \fBdependencies\fP specifically\. This
|
||
|
is useful if a package already exists in \fBdevDependencies\fP or
|
||
|
\fBoptionalDependencies\fP, but you want to move it to be a production dep\. This is
|
||
|
also the default behavior if \fB\-\-save\fP is true, and neither \fB\-\-save\-dev\fP or
|
||
|
\fB\-\-save\-optional\fP are true\.
|
||
|
.SS save\-dev
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Save installed packages to a package\.json file as \fBdevDependencies\fP\|\.
|
||
|
.P
|
||
|
When used with the \fBnpm rm\fP command, it removes it from the
|
||
|
\fBdevDependencies\fP object\.
|
||
|
.P
|
||
|
Only works if there is already a package\.json file present\.
|
||
|
.SS save\-exact
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Dependencies saved to package\.json using \fB\-\-save\fP, \fB\-\-save\-dev\fP or
|
||
|
\fB\-\-save\-optional\fP will be configured with an exact version rather than
|
||
|
using npm's default semver range operator\.
|
||
|
.SS save\-optional
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Save installed packages to a package\.json file as
|
||
|
optionalDependencies\.
|
||
|
.P
|
||
|
When used with the \fBnpm rm\fP command, it removes it from the
|
||
|
\fBdevDependencies\fP object\.
|
||
|
.P
|
||
|
Only works if there is already a package\.json file present\.
|
||
|
.SS save\-prefix
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: '^'
|
||
|
.IP \(bu 2
|
||
|
Type: String
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Configure how versions of packages installed to a package\.json file via
|
||
|
\fB\-\-save\fP or \fB\-\-save\-dev\fP get prefixed\.
|
||
|
.P
|
||
|
For example if a package has version \fB1\.2\.3\fP, by default its version is
|
||
|
set to \fB^1\.2\.3\fP which allows minor upgrades for that package, but after
|
||
|
\fBnpm config set save\-prefix='~'\fP it would be set to \fB~1\.2\.3\fP which only allows
|
||
|
patch upgrades\.
|
||
|
.SS scope
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: the scope of the current project, if any, or ""
|
||
|
.IP \(bu 2
|
||
|
Type: String
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Associate an operation with a scope for a scoped registry\. Useful when logging
|
||
|
in to a private registry for the first time:
|
||
|
\fBnpm login \-\-scope=@organization \-\-registry=registry\.organization\.com\fP, which
|
||
|
will cause \fB@organization\fP to be mapped to the registry for future installation
|
||
|
of packages specified according to the pattern \fB@organization/package\fP\|\.
|
||
|
.SS script\-shell
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: \fBnull\fP
|
||
|
.IP \(bu 2
|
||
|
Type: path
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
The shell to use for scripts run with the \fBnpm run\fP command\.
|
||
|
.SS scripts\-prepend\-node\-path
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: "warn\-only"
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean, \fB"auto"\fP or \fB"warn\-only"\fP
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
If set to \fBtrue\fP, add the directory in which the current \fBnode\fP executable
|
||
|
resides to the \fBPATH\fP environment variable when running scripts,
|
||
|
even if that means that \fBnpm\fP will invoke a different \fBnode\fP executable than
|
||
|
the one which it is running\.
|
||
|
.P
|
||
|
If set to \fBfalse\fP, never modify \fBPATH\fP with that\.
|
||
|
.P
|
||
|
If set to \fB"warn\-only"\fP, never modify \fBPATH\fP but print a warning if \fBnpm\fP thinks
|
||
|
that you may want to run it with \fBtrue\fP, e\.g\. because the \fBnode\fP executable
|
||
|
in the \fBPATH\fP is not the one \fBnpm\fP was invoked with\.
|
||
|
.P
|
||
|
If set to \fBauto\fP, only add that directory to the \fBPATH\fP environment variable
|
||
|
if the \fBnode\fP executable with which \fBnpm\fP was invoked and the one that is found
|
||
|
first on the \fBPATH\fP are different\.
|
||
|
.SS searchexclude
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: ""
|
||
|
.IP \(bu 2
|
||
|
Type: String
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Space\-separated options that limit the results from search\.
|
||
|
.SS searchopts
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: ""
|
||
|
.IP \(bu 2
|
||
|
Type: String
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Space\-separated options that are always passed to search\.
|
||
|
.SS searchlimit
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: 20
|
||
|
.IP \(bu 2
|
||
|
Type: Number
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Number of items to limit search results to\. Will not apply at all to legacy
|
||
|
searches\.
|
||
|
.SS searchstaleness
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: 900 (15 minutes)
|
||
|
.IP \(bu 2
|
||
|
Type: Number
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
The age of the cache, in seconds, before another registry request is made if
|
||
|
using legacy search endpoint\.
|
||
|
.SS send\-metrics
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
If true, success/failure metrics will be reported to the registry stored in
|
||
|
\fBmetrics\-registry\fP\|\. These requests contain the number of successful and
|
||
|
failing runs of the npm CLI and the time period overwhich those counts were
|
||
|
gathered\. No identifying information is included in these requests\.
|
||
|
.SS shell
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: SHELL environment variable, or "bash" on Posix, or "cmd" on
|
||
|
Windows
|
||
|
.IP \(bu 2
|
||
|
Type: path
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
The shell to run for the \fBnpm explore\fP command\.
|
||
|
.SS shrinkwrap
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: true
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
If set to false, then ignore \fBnpm\-shrinkwrap\.json\fP files when installing\. This
|
||
|
will also prevent \fIwriting\fR \fBnpm\-shrinkwrap\.json\fP if \fBsave\fP is true\.
|
||
|
.P
|
||
|
This option is an alias for \fB\-\-package\-lock\fP\|\.
|
||
|
.SS sign\-git\-commit
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
If set to true, then the \fBnpm version\fP command will commit the new package
|
||
|
version using \fB\-S\fP to add a signature\.
|
||
|
.P
|
||
|
Note that git requires you to have set up GPG keys in your git configs
|
||
|
for this to work properly\.
|
||
|
.SS sign\-git\-tag
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
If set to true, then the \fBnpm version\fP command will tag the version
|
||
|
using \fB\-s\fP to add a signature\.
|
||
|
.P
|
||
|
Note that git requires you to have set up GPG keys in your git configs
|
||
|
for this to work properly\.
|
||
|
.SS sso\-poll\-frequency
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: 500
|
||
|
.IP \(bu 2
|
||
|
Type: Number
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
When used with SSO\-enabled \fBauth\-type\fPs, configures how regularly the registry
|
||
|
should be polled while the user is completing authentication\.
|
||
|
.SS sso\-type
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: 'oauth'
|
||
|
.IP \(bu 2
|
||
|
Type: 'oauth', 'saml', or null
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
If \fB\-\-auth\-type=sso\fP, the type of SSO type to use\.
|
||
|
.SS strict\-ssl
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: true
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Whether or not to do SSL key validation when making requests to the
|
||
|
registry via https\.
|
||
|
.P
|
||
|
See also the \fBca\fP config\.
|
||
|
.SS tag
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: latest
|
||
|
.IP \(bu 2
|
||
|
Type: String
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
If you ask npm to install a package and don't tell it a specific version, then
|
||
|
it will install the specified tag\.
|
||
|
.P
|
||
|
Also the tag that is added to the package@version specified by the \fBnpm
|
||
|
tag\fP command, if no explicit tag is given\.
|
||
|
.SS tag\-version\-prefix
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: \fB"v"\fP
|
||
|
.IP \(bu 2
|
||
|
Type: String
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
If set, alters the prefix used when tagging a new version when performing a
|
||
|
version increment using \fBnpm\-version\fP\|\. To remove the prefix altogether, set it
|
||
|
to the empty string: \fB""\fP\|\.
|
||
|
.P
|
||
|
Because other tools may rely on the convention that npm version tags look like
|
||
|
\fBv1\.0\.0\fP, \fIonly use this property if it is absolutely necessary\fR\|\. In
|
||
|
particular, use care when overriding this setting for public packages\.
|
||
|
.SS timing
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: \fBfalse\fP
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
If true, writes an \fBnpm\-debug\fP log to \fB_logs\fP and timing information to
|
||
|
\fB_timing\.json\fP, both in your cache\. \fB_timing\.json\fP is a newline delimited
|
||
|
list of JSON objects\. You can quickly view it with this
|
||
|
json \fIhttps://www\.npmjs\.com/package/json\fR command line:
|
||
|
\fBjson \-g < ~/\.npm/_timing\.json\fP\|\.
|
||
|
.SS tmp
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: TMPDIR environment variable, or "/tmp"
|
||
|
.IP \(bu 2
|
||
|
Type: path
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Where to store temporary files and folders\. All temp files are deleted
|
||
|
on success, but left behind on failure for forensic purposes\.
|
||
|
.SS unicode
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false on windows, true on mac/unix systems with a unicode locale
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
When set to true, npm uses unicode characters in the tree output\. When
|
||
|
false, it uses ascii characters to draw trees\.
|
||
|
.SS unsafe\-perm
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false if running as root, true otherwise
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Set to true to suppress the UID/GID switching when running package
|
||
|
scripts\. If set explicitly to false, then installing as a non\-root user
|
||
|
will fail\.
|
||
|
.SS update\-notifier
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: true
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Set to false to suppress the update notification when using an older
|
||
|
version of npm than the latest\.
|
||
|
.SS usage
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: Boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Set to show short usage output (like the \-H output)
|
||
|
instead of complete help when doing npm help \fBhelp\fP\|\.
|
||
|
.SS user
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: "nobody"
|
||
|
.IP \(bu 2
|
||
|
Type: String or Number
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
The UID to set to when running package scripts as root\.
|
||
|
.SS userconfig
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: ~/\.npmrc
|
||
|
.IP \(bu 2
|
||
|
Type: path
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
The location of user\-level configuration settings\.
|
||
|
.SS umask
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: 022
|
||
|
.IP \(bu 2
|
||
|
Type: Octal numeric string in range 0000\.\.0777 (0\.\.511)
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
The "umask" value to use when setting the file creation mode on files
|
||
|
and folders\.
|
||
|
.P
|
||
|
Folders and executables are given a mode which is \fB0777\fP masked against
|
||
|
this value\. Other files are given a mode which is \fB0666\fP masked against
|
||
|
this value\. Thus, the defaults are \fB0755\fP and \fB0644\fP respectively\.
|
||
|
.SS user\-agent
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: node/{process\.version} {process\.platform} {process\.arch}
|
||
|
.IP \(bu 2
|
||
|
Type: String
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
Sets a User\-Agent to the request header
|
||
|
.SS version
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
If true, output the npm version and exit successfully\.
|
||
|
.P
|
||
|
Only relevant when specified explicitly on the command line\.
|
||
|
.SS versions
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: false
|
||
|
.IP \(bu 2
|
||
|
Type: boolean
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
If true, output the npm version as well as node's \fBprocess\.versions\fP map, and
|
||
|
exit successfully\.
|
||
|
.P
|
||
|
Only relevant when specified explicitly on the command line\.
|
||
|
.SS viewer
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
Default: "man" on Posix, "browser" on Windows
|
||
|
.IP \(bu 2
|
||
|
Type: path
|
||
|
|
||
|
.RE
|
||
|
.P
|
||
|
The program to use to view help content\.
|
||
|
.P
|
||
|
Set to \fB"browser"\fP to view html help content in the default web browser\.
|
||
|
.SS See also
|
||
|
.RS 0
|
||
|
.IP \(bu 2
|
||
|
npm help config
|
||
|
.IP \(bu 2
|
||
|
npm help npmrc
|
||
|
.IP \(bu 2
|
||
|
npm help scripts
|
||
|
.IP \(bu 2
|
||
|
npm help folders
|
||
|
.IP \(bu 2
|
||
|
npm help npm
|
||
|
|
||
|
.RE
|