codekingpro/portable-devtools

1.TH "NPM-INSTALL-CI-TEST" "1" "April 2026" "NPM@11.13.0" ""
2.SH "NAME"
3\fBnpm-install-ci-test\fR - Install a project with a clean slate and run tests
4.SS "Synopsis"
5.P
6.RS 2
7.nf
8npm install-ci-test
9
10aliases: cit, clean-install-test, sit
11.fi
12.RE
13.SS "Description"
14.P
15This command runs \fBnpm ci\fR followed immediately by \fBnpm test\fR.
16.SS "Configuration"
17.SS "\fBinstall-strategy\fR"
18.RS 0
19.IP \(bu 4
20Default: "hoisted"
21.IP \(bu 4
22Type: "hoisted", "nested", "shallow", or "linked"
23.RE 0
24
25.P
26Sets 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.
27.SS "\fBlegacy-bundling\fR"
28.RS 0
29.IP \(bu 4
30Default: false
31.IP \(bu 4
32Type: Boolean
33.IP \(bu 4
34DEPRECATED: This option has been deprecated in favor of \fB--install-strategy=nested\fR
35.RE 0
36
37.P
38Instead 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.
39.SS "\fBglobal-style\fR"
40.RS 0
41.IP \(bu 4
42Default: false
43.IP \(bu 4
44Type: Boolean
45.IP \(bu 4
46DEPRECATED: This option has been deprecated in favor of \fB--install-strategy=shallow\fR
47.RE 0
48
49.P
50Only install direct dependencies in the top level \fBnode_modules\fR, but hoist on deeper dependencies. Sets \fB--install-strategy=shallow\fR.
51.SS "\fBomit\fR"
52.RS 0
53.IP \(bu 4
54Default: 'dev' if the \fBNODE_ENV\fR environment variable is set to 'production'; otherwise, empty.
55.IP \(bu 4
56Type: "dev", "optional", or "peer" (can be set multiple times)
57.RE 0
58
59.P
60Dependency types to omit from the installation tree on disk.
61.P
62Note 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.
63.P
64If a package type appears in both the \fB--include\fR and \fB--omit\fR lists, then it will be included.
65.P
66If 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.
67.SS "\fBinclude\fR"
68.RS 0
69.IP \(bu 4
70Default:
71.IP \(bu 4
72Type: "prod", "dev", "optional", or "peer" (can be set multiple times)
73.RE 0
74
75.P
76Option that allows for defining which types of dependencies to install.
77.P
78This is the inverse of \fB--omit=<type>\fR.
79.P
80Dependency types specified in \fB--include\fR will not be omitted, regardless of the order in which omit/include are specified on the command-line.
81.SS "\fBstrict-peer-deps\fR"
82.RS 0
83.IP \(bu 4
84Default: false
85.IP \(bu 4
86Type: Boolean
87.RE 0
88
89.P
90If 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.
91.P
92By 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.
93.P
94When 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.
95.SS "\fBforeground-scripts\fR"
96.RS 0
97.IP \(bu 4
98Default: \fBfalse\fR unless when using \fBnpm pack\fR or \fBnpm publish\fR where it defaults to \fBtrue\fR
99.IP \(bu 4
100Type: Boolean
101.RE 0
102
103.P
104Run 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.
105.P
106Note that this will generally make installs run slower, and be much noisier, but can be useful for debugging.
107.SS "\fBignore-scripts\fR"
108.RS 0
109.IP \(bu 4
110Default: false
111.IP \(bu 4
112Type: Boolean
113.RE 0
114
115.P
116If true, npm does not run scripts specified in package.json files.
117.P
118Note 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.
119.SS "\fBallow-git\fR"
120.RS 0
121.IP \(bu 4
122Default: "all"
123.IP \(bu 4
124Type: "all", "none", or "root"
125.RE 0
126
127.P
128Limits 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.
129.P
130\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\fR
131.SS "\fBaudit\fR"
132.RS 0
133.IP \(bu 4
134Default: true
135.IP \(bu 4
136Type: Boolean
137.RE 0
138
139.P
140When "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.
141.SS "\fBbin-links\fR"
142.RS 0
143.IP \(bu 4
144Default: true
145.IP \(bu 4
146Type: Boolean
147.RE 0
148
149.P
150Tells npm to create symlinks (or \fB.cmd\fR shims on Windows) for package executables.
151.P
152Set 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.
153.SS "\fBfund\fR"
154.RS 0
155.IP \(bu 4
156Default: true
157.IP \(bu 4
158Type: Boolean
159.RE 0
160
161.P
162When "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.
163.SS "\fBdry-run\fR"
164.RS 0
165.IP \(bu 4
166Default: false
167.IP \(bu 4
168Type: Boolean
169.RE 0
170
171.P
172Indicates 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.
173.P
174Note: This is NOT honored by other network related commands, eg \fBdist-tags\fR, \fBowner\fR, etc.
175.SS "\fBworkspace\fR"
176.RS 0
177.IP \(bu 4
178Default:
179.IP \(bu 4
180Type: String (can be set multiple times)
181.RE 0
182
183.P
184Enable 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.
185.P
186Valid values for the \fBworkspace\fR config are either:
187.RS 0
188.IP \(bu 4
189Workspace names
190.IP \(bu 4
191Path to a workspace directory
192.IP \(bu 4
193Path to a parent workspace directory (will result in selecting all workspaces within that folder)
194.RE 0
195
196.P
197When 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.
198.P
199This value is not exported to the environment for child processes.
200.SS "\fBworkspaces\fR"
201.RS 0
202.IP \(bu 4
203Default: null
204.IP \(bu 4
205Type: null or Boolean
206.RE 0
207
208.P
209Set to true to run the command in the context of \fBall\fR configured workspaces.
210.P
211Explicitly setting this to false will cause commands like \fBinstall\fR to ignore workspaces altogether. When not set explicitly:
212.RS 0
213.IP \(bu 4
214Commands 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.
215.RE 0
216
217.P
218This value is not exported to the environment for child processes.
219.SS "\fBinclude-workspace-root\fR"
220.RS 0
221.IP \(bu 4
222Default: false
223.IP \(bu 4
224Type: Boolean
225.RE 0
226
227.P
228Include the workspace root when workspaces are enabled for a command.
229.P
230When 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.
231.P
232This value is not exported to the environment for child processes.
233.SS "\fBinstall-links\fR"
234.RS 0
235.IP \(bu 4
236Default: false
237.IP \(bu 4
238Type: Boolean
239.RE 0
240
241.P
242When set file: protocol dependencies will be packed and installed as regular dependencies instead of creating a symlink. This option has no effect on workspaces.
243.SS "See Also"
244.RS 0
245.IP \(bu 4
246npm help install-test
247.IP \(bu 4
248npm help ci
249.IP \(bu 4
250npm help test
251.RE 0
252