File Explorer

1.TH "NPM-INSTALL-TEST" "1" "February 2026" "NPM@11.11.0" ""2.SH "NAME"3\fBnpm-install-test\fR - Install package(s) and run tests4.SS "Synopsis"5.P6.RS 27.nf8npm install-test \[lB]<package-spec> ...\[rB]9 10alias: it11.fi12.RE13.SS "Description"14.P15This command runs an \fBnpm install\fR followed immediately by an \fBnpm test\fR. It takes exactly the same arguments as \fBnpm install\fR.16.SS "Configuration"17.SS "\fBsave\fR"18.RS 019.IP \(bu 420Default: \fBtrue\fR unless when using \fBnpm update\fR where it defaults to \fBfalse\fR21.IP \(bu 422Type: Boolean23.RE 024 25.P26Save installed packages to a \fBpackage.json\fR file as dependencies.27.P28When used with the \fBnpm rm\fR command, removes the dependency from \fBpackage.json\fR.29.P30Will also prevent writing to \fBpackage-lock.json\fR if set to \fBfalse\fR.31.SS "\fBsave-exact\fR"32.RS 033.IP \(bu 434Default: false35.IP \(bu 436Type: Boolean37.RE 038 39.P40Dependencies saved to package.json will be configured with an exact version rather than using npm's default semver range operator.41.SS "\fBglobal\fR"42.RS 043.IP \(bu 444Default: false45.IP \(bu 446Type: Boolean47.RE 048 49.P50Operates 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.51.RS 052.IP \(bu 453packages are installed into the \fB{prefix}/lib/node_modules\fR folder, instead of the current working directory.54.IP \(bu 455bin files are linked to \fB{prefix}/bin\fR56.IP \(bu 457man pages are linked to \fB{prefix}/share/man\fR58.RE 059 60.SS "\fBinstall-strategy\fR"61.RS 062.IP \(bu 463Default: "hoisted"64.IP \(bu 465Type: "hoisted", "nested", "shallow", or "linked"66.RE 067 68.P69Sets 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.70.SS "\fBlegacy-bundling\fR"71.RS 072.IP \(bu 473Default: false74.IP \(bu 475Type: Boolean76.IP \(bu 477DEPRECATED: This option has been deprecated in favor of \fB--install-strategy=nested\fR78.RE 079 80.P81Instead 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.82.SS "\fBglobal-style\fR"83.RS 084.IP \(bu 485Default: false86.IP \(bu 487Type: Boolean88.IP \(bu 489DEPRECATED: This option has been deprecated in favor of \fB--install-strategy=shallow\fR90.RE 091 92.P93Only install direct dependencies in the top level \fBnode_modules\fR, but hoist on deeper dependencies. Sets \fB--install-strategy=shallow\fR.94.SS "\fBomit\fR"95.RS 096.IP \(bu 497Default: 'dev' if the \fBNODE_ENV\fR environment variable is set to 'production'; otherwise, empty.98.IP \(bu 499Type: "dev", "optional", or "peer" (can be set multiple times)100.RE 0101 102.P103Dependency types to omit from the installation tree on disk.104.P105Note 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.106.P107If a package type appears in both the \fB--include\fR and \fB--omit\fR lists, then it will be included.108.P109If 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.110.SS "\fBinclude\fR"111.RS 0112.IP \(bu 4113Default:114.IP \(bu 4115Type: "prod", "dev", "optional", or "peer" (can be set multiple times)116.RE 0117 118.P119Option that allows for defining which types of dependencies to install.120.P121This is the inverse of \fB--omit=<type>\fR.122.P123Dependency types specified in \fB--include\fR will not be omitted, regardless of the order in which omit/include are specified on the command-line.124.SS "\fBstrict-peer-deps\fR"125.RS 0126.IP \(bu 4127Default: false128.IP \(bu 4129Type: Boolean130.RE 0131 132.P133If 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.134.P135By 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.136.P137When 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.138.SS "\fBprefer-dedupe\fR"139.RS 0140.IP \(bu 4141Default: false142.IP \(bu 4143Type: Boolean144.RE 0145 146.P147Prefer to deduplicate packages if possible, rather than choosing a newer version of a dependency.148.SS "\fBpackage-lock\fR"149.RS 0150.IP \(bu 4151Default: true152.IP \(bu 4153Type: Boolean154.RE 0155 156.P157If 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.158.SS "\fBpackage-lock-only\fR"159.RS 0160.IP \(bu 4161Default: false162.IP \(bu 4163Type: Boolean164.RE 0165 166.P167If set to true, the current operation will only use the \fBpackage-lock.json\fR, ignoring \fBnode_modules\fR.168.P169For \fBupdate\fR this means only the \fBpackage-lock.json\fR will be updated, instead of checking \fBnode_modules\fR and downloading dependencies.170.P171For \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.172.SS "\fBforeground-scripts\fR"173.RS 0174.IP \(bu 4175Default: \fBfalse\fR unless when using \fBnpm pack\fR or \fBnpm publish\fR where it defaults to \fBtrue\fR176.IP \(bu 4177Type: Boolean178.RE 0179 180.P181Run 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.182.P183Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging.184.SS "\fBignore-scripts\fR"185.RS 0186.IP \(bu 4187Default: false188.IP \(bu 4189Type: Boolean190.RE 0191 192.P193If true, npm does not run scripts specified in package.json files.194.P195Note 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.196.SS "\fBallow-git\fR"197.RS 0198.IP \(bu 4199Default: "all"200.IP \(bu 4201Type: "all", "none", or "root"202.RE 0203 204.P205Limits 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.206.P207\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\fR208.SS "\fBaudit\fR"209.RS 0210.IP \(bu 4211Default: true212.IP \(bu 4213Type: Boolean214.RE 0215 216.P217When "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.218.SS "\fBbefore\fR"219.RS 0220.IP \(bu 4221Default: null222.IP \(bu 4223Type: null or Date224.RE 0225 226.P227If 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.228.P229If 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.230.P231This config cannot be used with: \fBmin-release-age\fR232.SS "\fBmin-release-age\fR"233.RS 0234.IP \(bu 4235Default: null236.IP \(bu 4237Type: null or Number238.RE 0239 240.P241If 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.242.P243This flag is a complement to \fBbefore\fR, which accepts an exact date instead of a relative number of days.244.P245This config cannot be used with: \fBbefore\fR246.SS "\fBbin-links\fR"247.RS 0248.IP \(bu 4249Default: true250.IP \(bu 4251Type: Boolean252.RE 0253 254.P255Tells npm to create symlinks (or \fB.cmd\fR shims on Windows) for package executables.256.P257Set 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.258.SS "\fBfund\fR"259.RS 0260.IP \(bu 4261Default: true262.IP \(bu 4263Type: Boolean264.RE 0265 266.P267When "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.268.SS "\fBdry-run\fR"269.RS 0270.IP \(bu 4271Default: false272.IP \(bu 4273Type: Boolean274.RE 0275 276.P277Indicates 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.278.P279Note: This is NOT honored by other network related commands, eg \fBdist-tags\fR, \fBowner\fR, etc.280.SS "\fBcpu\fR"281.RS 0282.IP \(bu 4283Default: null284.IP \(bu 4285Type: null or String286.RE 0287 288.P289Override CPU architecture of native modules to install. Acceptable values are same as \fBcpu\fR field of package.json, which comes from \fBprocess.arch\fR.290.SS "\fBos\fR"291.RS 0292.IP \(bu 4293Default: null294.IP \(bu 4295Type: null or String296.RE 0297 298.P299Override OS of native modules to install. Acceptable values are same as \fBos\fR field of package.json, which comes from \fBprocess.platform\fR.300.SS "\fBlibc\fR"301.RS 0302.IP \(bu 4303Default: null304.IP \(bu 4305Type: null or String306.RE 0307 308.P309Override libc of native modules to install. Acceptable values are same as \fBlibc\fR field of package.json310.SS "\fBworkspace\fR"311.RS 0312.IP \(bu 4313Default:314.IP \(bu 4315Type: String (can be set multiple times)316.RE 0317 318.P319Enable 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.320.P321Valid values for the \fBworkspace\fR config are either:322.RS 0323.IP \(bu 4324Workspace names325.IP \(bu 4326Path to a workspace directory327.IP \(bu 4328Path to a parent workspace directory (will result in selecting all workspaces within that folder)329.RE 0330 331.P332When 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.333.P334This value is not exported to the environment for child processes.335.SS "\fBworkspaces\fR"336.RS 0337.IP \(bu 4338Default: null339.IP \(bu 4340Type: null or Boolean341.RE 0342 343.P344Set to true to run the command in the context of \fBall\fR configured workspaces.345.P346Explicitly setting this to false will cause commands like \fBinstall\fR to ignore workspaces altogether. When not set explicitly:347.RS 0348.IP \(bu 4349Commands 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.350.RE 0351 352.P353This value is not exported to the environment for child processes.354.SS "\fBinclude-workspace-root\fR"355.RS 0356.IP \(bu 4357Default: false358.IP \(bu 4359Type: Boolean360.RE 0361 362.P363Include the workspace root when workspaces are enabled for a command.364.P365When 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.366.P367This value is not exported to the environment for child processes.368.SS "\fBinstall-links\fR"369.RS 0370.IP \(bu 4371Default: false372.IP \(bu 4373Type: Boolean374.RE 0375 376.P377When set file: protocol dependencies will be packed and installed as regular dependencies instead of creating a symlink. This option has no effect on workspaces.378.SS "See Also"379.RS 0380.IP \(bu 4381npm help install382.IP \(bu 4383npm help install-ci-test384.IP \(bu 4385npm help test386.RE 0387