@cryptotaxi247 / documentation-1
Code Commits Issues Pulls Sessions CI/CD
reggi/dev-engines
@reggi/path-to-regexp dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2 dependabot/npm_and_yarn/main/eslint-10.4.0 dependabot/npm_and_yarn/main/npmcli/eslint-config-7.0.0 dependabot/npm_and_yarn/main/proc-log-7.0.0 dependabot/npm_and_yarn/npm_and_yarn-826852524d dependabot/npm_and_yarn/npm_and_yarn-ab9a7f4bc2 deprecate-totp-2fa dhei/classic-tokens gat-bypass-2fa-docs jpg619/fix-accessibility-content-flow jpg619/version-bump-tar-2 kartykp/gat-bypass-2fa-docs kartykp/upgrade-path-to-regex main maitxn/version-bump-tar patch-1 reggi/cache-based-on-version reggi/dev-engines reggi/fix-transform-prettier reggi/overrides update-search-sensitivity
mdx 287 lines 10.7 KB
Raw
1 ---
2 title: npm-install-test
3 section: 1
4 description: Install package(s) and run tests
5 github_repo: npm/cli
6 github_branch: latest
7 github_path: docs/lib/content/commands/npm-install-test.md
8 redirect_from:
9 - /cli-commands/install-test
10 - /cli-commands/npm-install-test
11 - /cli-documentation/cli-commands/install-test
12 - /cli-documentation/cli-commands/npm-install-test
13 - /cli-documentation/commands/install-test
14 - /cli-documentation/commands/npm-install-test
15 - /cli-documentation/install-test
16 - /cli-documentation/npm-install-test
17 - /cli-documentation/v10/cli-commands/install-test
18 - /cli-documentation/v10/cli-commands/npm-install-test
19 - /cli-documentation/v10/commands/install-test
20 - /cli-documentation/v10/commands/npm-install-test
21 - /cli-documentation/v10/install-test
22 - /cli-documentation/v10/npm-install-test
23 - /cli/cli-commands/install-test
24 - /cli/cli-commands/npm-install-test
25 - /cli/commands/install-test
26 - /cli/commands/npm-install-test
27 - /cli/install-test
28 - /cli/npm-install-test
29 - /cli/v10/cli-commands/install-test
30 - /cli/v10/cli-commands/npm-install-test
31 - /cli/v10/commands/install-test
32 - /cli/v10/install-test
33 - /cli/v10/npm-install-test
34 - /commands/install-test
35 - /commands/npm-install-test
36 ---
37
38 ### Synopsis
39
40 ```bash
41 npm install-test [<package-spec> ...]
42
43 alias: it
44 ```
45
46 ### Description
47
48 This command runs an `npm install` followed immediately by an `npm test`. It takes exactly the same arguments as `npm install`.
49
50 ### Configuration
51
52 #### `save`
53
54 - Default: `true` unless when using `npm update` where it defaults to `false`
55 - Type: Boolean
56
57 Save installed packages to a `package.json` file as dependencies.
58
59 When used with the `npm rm` command, removes the dependency from `package.json`.
60
61 Will also prevent writing to `package-lock.json` if set to `false`.
62
63 #### `save-exact`
64
65 - Default: false
66 - Type: Boolean
67
68 Dependencies saved to package.json will be configured with an exact version rather than using npm's default semver range operator.
69
70 #### `global`
71
72 - Default: false
73 - Type: Boolean
74
75 Operates in "global" mode, so that packages are installed into the `prefix` folder instead of the current working directory. See [folders](/cli/v10/configuring-npm/folders) for more on the differences in behavior.
76
77 - packages are installed into the `{prefix}/lib/node_modules` folder, instead of the current working directory.
78 - bin files are linked to `{prefix}/bin`
79 - man pages are linked to `{prefix}/share/man`
80
81 #### `install-strategy`
82
83 - Default: "hoisted"
84 - Type: "hoisted", "nested", "shallow", or "linked"
85
86 Sets 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.
87
88 #### `legacy-bundling`
89
90 - Default: false
91 - Type: Boolean
92 - DEPRECATED: This option has been deprecated in favor of `--install-strategy=nested`
93
94 Instead of hoisting package installs in `node_modules`, 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 `--install-strategy=nested`.
95
96 #### `global-style`
97
98 - Default: false
99 - Type: Boolean
100 - DEPRECATED: This option has been deprecated in favor of `--install-strategy=shallow`
101
102 Only install direct dependencies in the top level `node_modules`, but hoist on deeper dependencies. Sets `--install-strategy=shallow`.
103
104 #### `omit`
105
106 - Default: 'dev' if the `NODE_ENV` environment variable is set to 'production', otherwise empty.
107 - Type: "dev", "optional", or "peer" (can be set multiple times)
108
109 Dependency types to omit from the installation tree on disk.
110
111 Note that these dependencies _are_ still resolved and added to the `package-lock.json` or `npm-shrinkwrap.json` file. They are just not physically installed on disk.
112
113 If a package type appears in both the `--include` and `--omit` lists, then it will be included.
114
115 If the resulting omit list includes `'dev'`, then the `NODE_ENV` environment variable will be set to `'production'` for all lifecycle scripts.
116
117 #### `include`
118
119 - Default:
120 - Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
121
122 Option that allows for defining which types of dependencies to install.
123
124 This is the inverse of `--omit=<type>`.
125
126 Dependency types specified in `--include` will not be omitted, regardless of the order in which omit/include are specified on the command-line.
127
128 #### `strict-peer-deps`
129
130 - Default: false
131 - Type: Boolean
132
133 If set to `true`, and `--legacy-peer-deps` is not set, then _any_ conflicting `peerDependencies` will be treated as an install failure, even if npm could reasonably guess the appropriate resolution based on non-peer dependency relationships.
134
135 By default, conflicting `peerDependencies` 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 `peerDependencies` object.
136
137 When such an override is performed, a warning is printed, explaining the conflict and the packages involved. If `--strict-peer-deps` is set, then this warning is treated as a failure.
138
139 #### `prefer-dedupe`
140
141 - Default: false
142 - Type: Boolean
143
144 Prefer to deduplicate packages if possible, rather than choosing a newer version of a dependency.
145
146 #### `package-lock`
147
148 - Default: true
149 - Type: Boolean
150
151 If set to false, then ignore `package-lock.json` files when installing. This will also prevent _writing_ `package-lock.json` if `save` is true.
152
153 #### `package-lock-only`
154
155 - Default: false
156 - Type: Boolean
157
158 If set to true, the current operation will only use the `package-lock.json`, ignoring `node_modules`.
159
160 For `update` this means only the `package-lock.json` will be updated, instead of checking `node_modules` and downloading dependencies.
161
162 For `list` this means the output will be based on the tree described by the `package-lock.json`, rather than the contents of `node_modules`.
163
164 #### `foreground-scripts`
165
166 - Default: `false` unless when using `npm pack` or `npm publish` where it defaults to `true`
167 - Type: Boolean
168
169 Run all build scripts (ie, `preinstall`, `install`, and `postinstall`) scripts for installed packages in the foreground process, sharing standard input, output, and error with the main npm process.
170
171 Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging.
172
173 #### `ignore-scripts`
174
175 - Default: false
176 - Type: Boolean
177
178 If true, npm does not run scripts specified in package.json files.
179
180 Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will _not_ run any pre- or post-scripts.
181
182 #### `audit`
183
184 - Default: true
185 - Type: Boolean
186
187 When "true" submit audit reports alongside the current npm command to the default registry and all registries configured for scopes. See the documentation for [`npm audit`](/cli/v10/commands/npm-audit) for details on what is submitted.
188
189 #### `bin-links`
190
191 - Default: true
192 - Type: Boolean
193
194 Tells npm to create symlinks (or `.cmd` shims on Windows) for package executables.
195
196 Set to false to have it not do this. This can be used to work around the fact that some file systems don't support symlinks, even on ostensibly Unix systems.
197
198 #### `fund`
199
200 - Default: true
201 - Type: Boolean
202
203 When "true" displays the message at the end of each `npm install` acknowledging the number of dependencies looking for funding. See [`npm fund`](/cli/v10/commands/npm-fund) for details.
204
205 #### `dry-run`
206
207 - Default: false
208 - Type: Boolean
209
210 Indicates 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, `install`, `update`, `dedupe`, `uninstall`, as well as `pack` and `publish`.
211
212 Note: This is NOT honored by other network related commands, eg `dist-tags`, `owner`, etc.
213
214 #### `cpu`
215
216 - Default: null
217 - Type: null or String
218
219 Override CPU architecture of native modules to install. Acceptable values are same as `cpu` field of package.json, which comes from `process.arch`.
220
221 #### `os`
222
223 - Default: null
224 - Type: null or String
225
226 Override OS of native modules to install. Acceptable values are same as `os` field of package.json, which comes from `process.platform`.
227
228 #### `libc`
229
230 - Default: null
231 - Type: null or String
232
233 Override libc of native modules to install. Acceptable values are same as `libc` field of package.json
234
235 #### `workspace`
236
237 - Default:
238 - Type: String (can be set multiple times)
239
240 Enable 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.
241
242 Valid values for the `workspace` config are either:
243
244 - Workspace names
245 - Path to a workspace directory
246 - Path to a parent workspace directory (will result in selecting all workspaces within that folder)
247
248 When set for the `npm init` 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.
249
250 This value is not exported to the environment for child processes.
251
252 #### `workspaces`
253
254 - Default: null
255 - Type: null or Boolean
256
257 Set to true to run the command in the context of **all** configured workspaces.
258
259 Explicitly setting this to false will cause commands like `install` to ignore workspaces altogether. When not set explicitly:
260
261 - Commands that operate on the `node_modules` tree (install, update, etc.) will link workspaces into the `node_modules` folder. - Commands that do other things (test, exec, publish, etc.) will operate on the root project, _unless_ one or more workspaces are specified in the `workspace` config.
262
263 This value is not exported to the environment for child processes.
264
265 #### `include-workspace-root`
266
267 - Default: false
268 - Type: Boolean
269
270 Include the workspace root when workspaces are enabled for a command.
271
272 When false, specifying individual workspaces via the `workspace` config, or all workspaces via the `workspaces` flag, will cause npm to operate only on the specified workspaces, and not on the root project.
273
274 This value is not exported to the environment for child processes.
275
276 #### `install-links`
277
278 - Default: false
279 - Type: Boolean
280
281 When set file: protocol dependencies will be packed and installed as regular dependencies instead of creating a symlink. This option has no effect on workspaces.
282
283 ### See Also
284
285 - [npm install](/cli/v10/commands/npm-install)
286 - [npm install-ci-test](/cli/v10/commands/npm-install-ci-test)
287 - [npm test](/cli/v10/commands/npm-test)