11cb0ef41Sopenharmony_ci---
21cb0ef41Sopenharmony_cititle: npm-install-test
31cb0ef41Sopenharmony_cisection: 1
41cb0ef41Sopenharmony_cidescription: Install package(s) and run tests
51cb0ef41Sopenharmony_ci---
61cb0ef41Sopenharmony_ci
71cb0ef41Sopenharmony_ci### Synopsis
81cb0ef41Sopenharmony_ci
91cb0ef41Sopenharmony_ci```bash
101cb0ef41Sopenharmony_cinpm install-test [<package-spec> ...]
111cb0ef41Sopenharmony_ci
121cb0ef41Sopenharmony_cialias: it
131cb0ef41Sopenharmony_ci```
141cb0ef41Sopenharmony_ci
151cb0ef41Sopenharmony_ci### Description
161cb0ef41Sopenharmony_ci
171cb0ef41Sopenharmony_ciThis command runs an `npm install` followed immediately by an `npm test`. It
181cb0ef41Sopenharmony_citakes exactly the same arguments as `npm install`.
191cb0ef41Sopenharmony_ci
201cb0ef41Sopenharmony_ci### Configuration
211cb0ef41Sopenharmony_ci
221cb0ef41Sopenharmony_ci#### `save`
231cb0ef41Sopenharmony_ci
241cb0ef41Sopenharmony_ci* Default: `true` unless when using `npm update` where it defaults to `false`
251cb0ef41Sopenharmony_ci* Type: Boolean
261cb0ef41Sopenharmony_ci
271cb0ef41Sopenharmony_ciSave installed packages to a `package.json` file as dependencies.
281cb0ef41Sopenharmony_ci
291cb0ef41Sopenharmony_ciWhen used with the `npm rm` command, removes the dependency from
301cb0ef41Sopenharmony_ci`package.json`.
311cb0ef41Sopenharmony_ci
321cb0ef41Sopenharmony_ciWill also prevent writing to `package-lock.json` if set to `false`.
331cb0ef41Sopenharmony_ci
341cb0ef41Sopenharmony_ci
351cb0ef41Sopenharmony_ci
361cb0ef41Sopenharmony_ci#### `save-exact`
371cb0ef41Sopenharmony_ci
381cb0ef41Sopenharmony_ci* Default: false
391cb0ef41Sopenharmony_ci* Type: Boolean
401cb0ef41Sopenharmony_ci
411cb0ef41Sopenharmony_ciDependencies saved to package.json will be configured with an exact version
421cb0ef41Sopenharmony_cirather than using npm's default semver range operator.
431cb0ef41Sopenharmony_ci
441cb0ef41Sopenharmony_ci
451cb0ef41Sopenharmony_ci
461cb0ef41Sopenharmony_ci#### `global`
471cb0ef41Sopenharmony_ci
481cb0ef41Sopenharmony_ci* Default: false
491cb0ef41Sopenharmony_ci* Type: Boolean
501cb0ef41Sopenharmony_ci
511cb0ef41Sopenharmony_ciOperates in "global" mode, so that packages are installed into the `prefix`
521cb0ef41Sopenharmony_cifolder instead of the current working directory. See
531cb0ef41Sopenharmony_ci[folders](/configuring-npm/folders) for more on the differences in behavior.
541cb0ef41Sopenharmony_ci
551cb0ef41Sopenharmony_ci* packages are installed into the `{prefix}/lib/node_modules` folder, instead
561cb0ef41Sopenharmony_ci  of the current working directory.
571cb0ef41Sopenharmony_ci* bin files are linked to `{prefix}/bin`
581cb0ef41Sopenharmony_ci* man pages are linked to `{prefix}/share/man`
591cb0ef41Sopenharmony_ci
601cb0ef41Sopenharmony_ci
611cb0ef41Sopenharmony_ci
621cb0ef41Sopenharmony_ci#### `install-strategy`
631cb0ef41Sopenharmony_ci
641cb0ef41Sopenharmony_ci* Default: "hoisted"
651cb0ef41Sopenharmony_ci* Type: "hoisted", "nested", "shallow", or "linked"
661cb0ef41Sopenharmony_ci
671cb0ef41Sopenharmony_ciSets the strategy for installing packages in node_modules. hoisted
681cb0ef41Sopenharmony_ci(default): Install non-duplicated in top-level, and duplicated as necessary
691cb0ef41Sopenharmony_ciwithin directory structure. nested: (formerly --legacy-bundling) install in
701cb0ef41Sopenharmony_ciplace, no hoisting. shallow (formerly --global-style) only install direct
711cb0ef41Sopenharmony_cideps at top-level. linked: (experimental) install in node_modules/.store,
721cb0ef41Sopenharmony_cilink in place, unhoisted.
731cb0ef41Sopenharmony_ci
741cb0ef41Sopenharmony_ci
751cb0ef41Sopenharmony_ci
761cb0ef41Sopenharmony_ci#### `legacy-bundling`
771cb0ef41Sopenharmony_ci
781cb0ef41Sopenharmony_ci* Default: false
791cb0ef41Sopenharmony_ci* Type: Boolean
801cb0ef41Sopenharmony_ci* DEPRECATED: This option has been deprecated in favor of
811cb0ef41Sopenharmony_ci  `--install-strategy=nested`
821cb0ef41Sopenharmony_ci
831cb0ef41Sopenharmony_ciInstead of hoisting package installs in `node_modules`, install packages in
841cb0ef41Sopenharmony_cithe same manner that they are depended on. This may cause very deep
851cb0ef41Sopenharmony_cidirectory structures and duplicate package installs as there is no
861cb0ef41Sopenharmony_cide-duplicating. Sets `--install-strategy=nested`.
871cb0ef41Sopenharmony_ci
881cb0ef41Sopenharmony_ci
891cb0ef41Sopenharmony_ci
901cb0ef41Sopenharmony_ci#### `global-style`
911cb0ef41Sopenharmony_ci
921cb0ef41Sopenharmony_ci* Default: false
931cb0ef41Sopenharmony_ci* Type: Boolean
941cb0ef41Sopenharmony_ci* DEPRECATED: This option has been deprecated in favor of
951cb0ef41Sopenharmony_ci  `--install-strategy=shallow`
961cb0ef41Sopenharmony_ci
971cb0ef41Sopenharmony_ciOnly install direct dependencies in the top level `node_modules`, but hoist
981cb0ef41Sopenharmony_cion deeper dependencies. Sets `--install-strategy=shallow`.
991cb0ef41Sopenharmony_ci
1001cb0ef41Sopenharmony_ci
1011cb0ef41Sopenharmony_ci
1021cb0ef41Sopenharmony_ci#### `omit`
1031cb0ef41Sopenharmony_ci
1041cb0ef41Sopenharmony_ci* Default: 'dev' if the `NODE_ENV` environment variable is set to
1051cb0ef41Sopenharmony_ci  'production', otherwise empty.
1061cb0ef41Sopenharmony_ci* Type: "dev", "optional", or "peer" (can be set multiple times)
1071cb0ef41Sopenharmony_ci
1081cb0ef41Sopenharmony_ciDependency types to omit from the installation tree on disk.
1091cb0ef41Sopenharmony_ci
1101cb0ef41Sopenharmony_ciNote that these dependencies _are_ still resolved and added to the
1111cb0ef41Sopenharmony_ci`package-lock.json` or `npm-shrinkwrap.json` file. They are just not
1121cb0ef41Sopenharmony_ciphysically installed on disk.
1131cb0ef41Sopenharmony_ci
1141cb0ef41Sopenharmony_ciIf a package type appears in both the `--include` and `--omit` lists, then
1151cb0ef41Sopenharmony_ciit will be included.
1161cb0ef41Sopenharmony_ci
1171cb0ef41Sopenharmony_ciIf the resulting omit list includes `'dev'`, then the `NODE_ENV` environment
1181cb0ef41Sopenharmony_civariable will be set to `'production'` for all lifecycle scripts.
1191cb0ef41Sopenharmony_ci
1201cb0ef41Sopenharmony_ci
1211cb0ef41Sopenharmony_ci
1221cb0ef41Sopenharmony_ci#### `include`
1231cb0ef41Sopenharmony_ci
1241cb0ef41Sopenharmony_ci* Default:
1251cb0ef41Sopenharmony_ci* Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
1261cb0ef41Sopenharmony_ci
1271cb0ef41Sopenharmony_ciOption that allows for defining which types of dependencies to install.
1281cb0ef41Sopenharmony_ci
1291cb0ef41Sopenharmony_ciThis is the inverse of `--omit=<type>`.
1301cb0ef41Sopenharmony_ci
1311cb0ef41Sopenharmony_ciDependency types specified in `--include` will not be omitted, regardless of
1321cb0ef41Sopenharmony_cithe order in which omit/include are specified on the command-line.
1331cb0ef41Sopenharmony_ci
1341cb0ef41Sopenharmony_ci
1351cb0ef41Sopenharmony_ci
1361cb0ef41Sopenharmony_ci#### `strict-peer-deps`
1371cb0ef41Sopenharmony_ci
1381cb0ef41Sopenharmony_ci* Default: false
1391cb0ef41Sopenharmony_ci* Type: Boolean
1401cb0ef41Sopenharmony_ci
1411cb0ef41Sopenharmony_ciIf set to `true`, and `--legacy-peer-deps` is not set, then _any_
1421cb0ef41Sopenharmony_ciconflicting `peerDependencies` will be treated as an install failure, even
1431cb0ef41Sopenharmony_ciif npm could reasonably guess the appropriate resolution based on non-peer
1441cb0ef41Sopenharmony_cidependency relationships.
1451cb0ef41Sopenharmony_ci
1461cb0ef41Sopenharmony_ciBy default, conflicting `peerDependencies` deep in the dependency graph will
1471cb0ef41Sopenharmony_cibe resolved using the nearest non-peer dependency specification, even if
1481cb0ef41Sopenharmony_cidoing so will result in some packages receiving a peer dependency outside
1491cb0ef41Sopenharmony_cithe range set in their package's `peerDependencies` object.
1501cb0ef41Sopenharmony_ci
1511cb0ef41Sopenharmony_ciWhen such an override is performed, a warning is printed, explaining the
1521cb0ef41Sopenharmony_ciconflict and the packages involved. If `--strict-peer-deps` is set, then
1531cb0ef41Sopenharmony_cithis warning is treated as a failure.
1541cb0ef41Sopenharmony_ci
1551cb0ef41Sopenharmony_ci
1561cb0ef41Sopenharmony_ci
1571cb0ef41Sopenharmony_ci#### `prefer-dedupe`
1581cb0ef41Sopenharmony_ci
1591cb0ef41Sopenharmony_ci* Default: false
1601cb0ef41Sopenharmony_ci* Type: Boolean
1611cb0ef41Sopenharmony_ci
1621cb0ef41Sopenharmony_ciPrefer to deduplicate packages if possible, rather than choosing a newer
1631cb0ef41Sopenharmony_civersion of a dependency.
1641cb0ef41Sopenharmony_ci
1651cb0ef41Sopenharmony_ci
1661cb0ef41Sopenharmony_ci
1671cb0ef41Sopenharmony_ci#### `package-lock`
1681cb0ef41Sopenharmony_ci
1691cb0ef41Sopenharmony_ci* Default: true
1701cb0ef41Sopenharmony_ci* Type: Boolean
1711cb0ef41Sopenharmony_ci
1721cb0ef41Sopenharmony_ciIf set to false, then ignore `package-lock.json` files when installing. This
1731cb0ef41Sopenharmony_ciwill also prevent _writing_ `package-lock.json` if `save` is true.
1741cb0ef41Sopenharmony_ci
1751cb0ef41Sopenharmony_ci
1761cb0ef41Sopenharmony_ci
1771cb0ef41Sopenharmony_ci#### `package-lock-only`
1781cb0ef41Sopenharmony_ci
1791cb0ef41Sopenharmony_ci* Default: false
1801cb0ef41Sopenharmony_ci* Type: Boolean
1811cb0ef41Sopenharmony_ci
1821cb0ef41Sopenharmony_ciIf set to true, the current operation will only use the `package-lock.json`,
1831cb0ef41Sopenharmony_ciignoring `node_modules`.
1841cb0ef41Sopenharmony_ci
1851cb0ef41Sopenharmony_ciFor `update` this means only the `package-lock.json` will be updated,
1861cb0ef41Sopenharmony_ciinstead of checking `node_modules` and downloading dependencies.
1871cb0ef41Sopenharmony_ci
1881cb0ef41Sopenharmony_ciFor `list` this means the output will be based on the tree described by the
1891cb0ef41Sopenharmony_ci`package-lock.json`, rather than the contents of `node_modules`.
1901cb0ef41Sopenharmony_ci
1911cb0ef41Sopenharmony_ci
1921cb0ef41Sopenharmony_ci
1931cb0ef41Sopenharmony_ci#### `foreground-scripts`
1941cb0ef41Sopenharmony_ci
1951cb0ef41Sopenharmony_ci* Default: `false` unless when using `npm pack` or `npm publish` where it
1961cb0ef41Sopenharmony_ci  defaults to `true`
1971cb0ef41Sopenharmony_ci* Type: Boolean
1981cb0ef41Sopenharmony_ci
1991cb0ef41Sopenharmony_ciRun all build scripts (ie, `preinstall`, `install`, and `postinstall`)
2001cb0ef41Sopenharmony_ciscripts for installed packages in the foreground process, sharing standard
2011cb0ef41Sopenharmony_ciinput, output, and error with the main npm process.
2021cb0ef41Sopenharmony_ci
2031cb0ef41Sopenharmony_ciNote that this will generally make installs run slower, and be much noisier,
2041cb0ef41Sopenharmony_cibut can be useful for debugging.
2051cb0ef41Sopenharmony_ci
2061cb0ef41Sopenharmony_ci
2071cb0ef41Sopenharmony_ci
2081cb0ef41Sopenharmony_ci#### `ignore-scripts`
2091cb0ef41Sopenharmony_ci
2101cb0ef41Sopenharmony_ci* Default: false
2111cb0ef41Sopenharmony_ci* Type: Boolean
2121cb0ef41Sopenharmony_ci
2131cb0ef41Sopenharmony_ciIf true, npm does not run scripts specified in package.json files.
2141cb0ef41Sopenharmony_ci
2151cb0ef41Sopenharmony_ciNote that commands explicitly intended to run a particular script, such as
2161cb0ef41Sopenharmony_ci`npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script`
2171cb0ef41Sopenharmony_ciwill still run their intended script if `ignore-scripts` is set, but they
2181cb0ef41Sopenharmony_ciwill *not* run any pre- or post-scripts.
2191cb0ef41Sopenharmony_ci
2201cb0ef41Sopenharmony_ci
2211cb0ef41Sopenharmony_ci
2221cb0ef41Sopenharmony_ci#### `audit`
2231cb0ef41Sopenharmony_ci
2241cb0ef41Sopenharmony_ci* Default: true
2251cb0ef41Sopenharmony_ci* Type: Boolean
2261cb0ef41Sopenharmony_ci
2271cb0ef41Sopenharmony_ciWhen "true" submit audit reports alongside the current npm command to the
2281cb0ef41Sopenharmony_cidefault registry and all registries configured for scopes. See the
2291cb0ef41Sopenharmony_cidocumentation for [`npm audit`](/commands/npm-audit) for details on what is
2301cb0ef41Sopenharmony_cisubmitted.
2311cb0ef41Sopenharmony_ci
2321cb0ef41Sopenharmony_ci
2331cb0ef41Sopenharmony_ci
2341cb0ef41Sopenharmony_ci#### `bin-links`
2351cb0ef41Sopenharmony_ci
2361cb0ef41Sopenharmony_ci* Default: true
2371cb0ef41Sopenharmony_ci* Type: Boolean
2381cb0ef41Sopenharmony_ci
2391cb0ef41Sopenharmony_ciTells npm to create symlinks (or `.cmd` shims on Windows) for package
2401cb0ef41Sopenharmony_ciexecutables.
2411cb0ef41Sopenharmony_ci
2421cb0ef41Sopenharmony_ciSet to false to have it not do this. This can be used to work around the
2431cb0ef41Sopenharmony_cifact that some file systems don't support symlinks, even on ostensibly Unix
2441cb0ef41Sopenharmony_cisystems.
2451cb0ef41Sopenharmony_ci
2461cb0ef41Sopenharmony_ci
2471cb0ef41Sopenharmony_ci
2481cb0ef41Sopenharmony_ci#### `fund`
2491cb0ef41Sopenharmony_ci
2501cb0ef41Sopenharmony_ci* Default: true
2511cb0ef41Sopenharmony_ci* Type: Boolean
2521cb0ef41Sopenharmony_ci
2531cb0ef41Sopenharmony_ciWhen "true" displays the message at the end of each `npm install`
2541cb0ef41Sopenharmony_ciacknowledging the number of dependencies looking for funding. See [`npm
2551cb0ef41Sopenharmony_cifund`](/commands/npm-fund) for details.
2561cb0ef41Sopenharmony_ci
2571cb0ef41Sopenharmony_ci
2581cb0ef41Sopenharmony_ci
2591cb0ef41Sopenharmony_ci#### `dry-run`
2601cb0ef41Sopenharmony_ci
2611cb0ef41Sopenharmony_ci* Default: false
2621cb0ef41Sopenharmony_ci* Type: Boolean
2631cb0ef41Sopenharmony_ci
2641cb0ef41Sopenharmony_ciIndicates that you don't want npm to make any changes and that it should
2651cb0ef41Sopenharmony_cionly report what it would have done. This can be passed into any of the
2661cb0ef41Sopenharmony_cicommands that modify your local installation, eg, `install`, `update`,
2671cb0ef41Sopenharmony_ci`dedupe`, `uninstall`, as well as `pack` and `publish`.
2681cb0ef41Sopenharmony_ci
2691cb0ef41Sopenharmony_ciNote: This is NOT honored by other network related commands, eg `dist-tags`,
2701cb0ef41Sopenharmony_ci`owner`, etc.
2711cb0ef41Sopenharmony_ci
2721cb0ef41Sopenharmony_ci
2731cb0ef41Sopenharmony_ci
2741cb0ef41Sopenharmony_ci#### `cpu`
2751cb0ef41Sopenharmony_ci
2761cb0ef41Sopenharmony_ci* Default: null
2771cb0ef41Sopenharmony_ci* Type: null or String
2781cb0ef41Sopenharmony_ci
2791cb0ef41Sopenharmony_ciOverride CPU architecture of native modules to install. Acceptable values
2801cb0ef41Sopenharmony_ciare same as `cpu` field of package.json, which comes from `process.arch`.
2811cb0ef41Sopenharmony_ci
2821cb0ef41Sopenharmony_ci
2831cb0ef41Sopenharmony_ci
2841cb0ef41Sopenharmony_ci#### `os`
2851cb0ef41Sopenharmony_ci
2861cb0ef41Sopenharmony_ci* Default: null
2871cb0ef41Sopenharmony_ci* Type: null or String
2881cb0ef41Sopenharmony_ci
2891cb0ef41Sopenharmony_ciOverride OS of native modules to install. Acceptable values are same as `os`
2901cb0ef41Sopenharmony_cifield of package.json, which comes from `process.platform`.
2911cb0ef41Sopenharmony_ci
2921cb0ef41Sopenharmony_ci
2931cb0ef41Sopenharmony_ci
2941cb0ef41Sopenharmony_ci#### `libc`
2951cb0ef41Sopenharmony_ci
2961cb0ef41Sopenharmony_ci* Default: null
2971cb0ef41Sopenharmony_ci* Type: null or String
2981cb0ef41Sopenharmony_ci
2991cb0ef41Sopenharmony_ciOverride libc of native modules to install. Acceptable values are same as
3001cb0ef41Sopenharmony_ci`libc` field of package.json
3011cb0ef41Sopenharmony_ci
3021cb0ef41Sopenharmony_ci
3031cb0ef41Sopenharmony_ci
3041cb0ef41Sopenharmony_ci#### `workspace`
3051cb0ef41Sopenharmony_ci
3061cb0ef41Sopenharmony_ci* Default:
3071cb0ef41Sopenharmony_ci* Type: String (can be set multiple times)
3081cb0ef41Sopenharmony_ci
3091cb0ef41Sopenharmony_ciEnable running a command in the context of the configured workspaces of the
3101cb0ef41Sopenharmony_cicurrent project while filtering by running only the workspaces defined by
3111cb0ef41Sopenharmony_cithis configuration option.
3121cb0ef41Sopenharmony_ci
3131cb0ef41Sopenharmony_ciValid values for the `workspace` config are either:
3141cb0ef41Sopenharmony_ci
3151cb0ef41Sopenharmony_ci* Workspace names
3161cb0ef41Sopenharmony_ci* Path to a workspace directory
3171cb0ef41Sopenharmony_ci* Path to a parent workspace directory (will result in selecting all
3181cb0ef41Sopenharmony_ci  workspaces within that folder)
3191cb0ef41Sopenharmony_ci
3201cb0ef41Sopenharmony_ciWhen set for the `npm init` command, this may be set to the folder of a
3211cb0ef41Sopenharmony_ciworkspace which does not yet exist, to create the folder and set it up as a
3221cb0ef41Sopenharmony_cibrand new workspace within the project.
3231cb0ef41Sopenharmony_ci
3241cb0ef41Sopenharmony_ciThis value is not exported to the environment for child processes.
3251cb0ef41Sopenharmony_ci
3261cb0ef41Sopenharmony_ci#### `workspaces`
3271cb0ef41Sopenharmony_ci
3281cb0ef41Sopenharmony_ci* Default: null
3291cb0ef41Sopenharmony_ci* Type: null or Boolean
3301cb0ef41Sopenharmony_ci
3311cb0ef41Sopenharmony_ciSet to true to run the command in the context of **all** configured
3321cb0ef41Sopenharmony_ciworkspaces.
3331cb0ef41Sopenharmony_ci
3341cb0ef41Sopenharmony_ciExplicitly setting this to false will cause commands like `install` to
3351cb0ef41Sopenharmony_ciignore workspaces altogether. When not set explicitly:
3361cb0ef41Sopenharmony_ci
3371cb0ef41Sopenharmony_ci- Commands that operate on the `node_modules` tree (install, update, etc.)
3381cb0ef41Sopenharmony_ciwill link workspaces into the `node_modules` folder. - Commands that do
3391cb0ef41Sopenharmony_ciother things (test, exec, publish, etc.) will operate on the root project,
3401cb0ef41Sopenharmony_ci_unless_ one or more workspaces are specified in the `workspace` config.
3411cb0ef41Sopenharmony_ci
3421cb0ef41Sopenharmony_ciThis value is not exported to the environment for child processes.
3431cb0ef41Sopenharmony_ci
3441cb0ef41Sopenharmony_ci#### `include-workspace-root`
3451cb0ef41Sopenharmony_ci
3461cb0ef41Sopenharmony_ci* Default: false
3471cb0ef41Sopenharmony_ci* Type: Boolean
3481cb0ef41Sopenharmony_ci
3491cb0ef41Sopenharmony_ciInclude the workspace root when workspaces are enabled for a command.
3501cb0ef41Sopenharmony_ci
3511cb0ef41Sopenharmony_ciWhen false, specifying individual workspaces via the `workspace` config, or
3521cb0ef41Sopenharmony_ciall workspaces via the `workspaces` flag, will cause npm to operate only on
3531cb0ef41Sopenharmony_cithe specified workspaces, and not on the root project.
3541cb0ef41Sopenharmony_ci
3551cb0ef41Sopenharmony_ciThis value is not exported to the environment for child processes.
3561cb0ef41Sopenharmony_ci
3571cb0ef41Sopenharmony_ci#### `install-links`
3581cb0ef41Sopenharmony_ci
3591cb0ef41Sopenharmony_ci* Default: false
3601cb0ef41Sopenharmony_ci* Type: Boolean
3611cb0ef41Sopenharmony_ci
3621cb0ef41Sopenharmony_ciWhen set file: protocol dependencies will be packed and installed as regular
3631cb0ef41Sopenharmony_cidependencies instead of creating a symlink. This option has no effect on
3641cb0ef41Sopenharmony_ciworkspaces.
3651cb0ef41Sopenharmony_ci
3661cb0ef41Sopenharmony_ci
3671cb0ef41Sopenharmony_ci
3681cb0ef41Sopenharmony_ci### See Also
3691cb0ef41Sopenharmony_ci
3701cb0ef41Sopenharmony_ci* [npm install](/commands/npm-install)
3711cb0ef41Sopenharmony_ci* [npm install-ci-test](/commands/npm-install-ci-test)
3721cb0ef41Sopenharmony_ci* [npm test](/commands/npm-test)
373