@@ -187,6 +187,124 @@ Fail an audit only if the results include a vulnerability with a level of modera
187187$ npm audit --audit-level=moderate
188188```
189189
190+ ### Configuration
191+
192+ <!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
193+ <!-- automatically generated, do not edit manually -->
194+ #### ` audit-level `
195+
196+ * Default: null
197+ * Type: null, "info", "low", "moderate", "high", "critical", or "none"
198+
199+ The minimum level of vulnerability for ` npm audit ` to exit with a non-zero
200+ exit code.
201+
202+ #### ` dry-run `
203+
204+ * Default: false
205+ * Type: Boolean
206+
207+ Indicates that you don't want npm to make any changes and that it should
208+ only report what it would have done. This can be passed into any of the
209+ commands that modify your local installation, eg, ` install ` , ` update ` ,
210+ ` dedupe ` , ` uninstall ` , as well as ` pack ` and ` publish ` .
211+
212+ Note: This is NOT honored by other network related commands, eg ` dist-tags ` ,
213+ ` owner ` , etc.
214+
215+ #### ` force `
216+
217+ * Default: false
218+ * Type: Boolean
219+
220+ Removes various protections against unfortunate side effects, common
221+ mistakes, unnecessary performance degradation, and malicious input.
222+
223+ * Allow clobbering non-npm files in global installs.
224+ * Allow the ` npm version ` command to work on an unclean git repository.
225+ * Allow deleting the cache folder with ` npm cache clean ` .
226+ * Allow installing packages that have an ` engines ` declaration requiring a
227+ different version of npm.
228+ * Allow installing packages that have an ` engines ` declaration requiring a
229+ different version of ` node ` , even if ` --engine-strict ` is enabled.
230+ * Allow ` npm audit fix ` to install modules outside your stated dependency
231+ range (including SemVer-major changes).
232+ * Allow unpublishing all versions of a published package.
233+ * Allow conflicting peerDependencies to be installed in the root project.
234+ * Implicitly set ` --yes ` during ` npm init ` .
235+
236+ If you don't have a clear idea of what you want to do, it is strongly
237+ recommended that you do not use this option!
238+
239+ #### ` json `
240+
241+ * Default: false
242+ * Type: Boolean
243+
244+ Whether or not to output JSON data, rather than the normal output.
245+
246+ Not supported by all npm commands.
247+
248+ #### ` package-lock-only `
249+
250+ * Default: false
251+ * Type: Boolean
252+
253+ If set to true, it will update only the ` package-lock.json ` , instead of
254+ checking ` node_modules ` and downloading dependencies.
255+
256+ #### ` omit `
257+
258+ * Default: 'dev' if the ` NODE_ENV ` environment variable is set to
259+ 'production', otherwise empty.
260+ * Type: "dev", "optional", or "peer" (can be set multiple times)
261+
262+ Dependency types to omit from the installation tree on disk.
263+
264+ Note that these dependencies _ are_ still resolved and added to the
265+ ` package-lock.json ` or ` npm-shrinkwrap.json ` file. They are just not
266+ physically installed on disk.
267+
268+ If a package type appears in both the ` --include ` and ` --omit ` lists, then
269+ it will be included.
270+
271+ If the resulting omit list includes ` 'dev' ` , then the ` NODE_ENV ` environment
272+ variable will be set to ` 'production' ` for all lifecycle scripts.
273+
274+ #### ` workspace `
275+
276+ * Default:
277+ * Type: String (can be set multiple times)
278+
279+ Enable running a command in the context of the configured workspaces of the
280+ current project while filtering by running only the workspaces defined by
281+ this configuration option.
282+
283+ Valid values for the ` workspace ` config are either:
284+
285+ * Workspace names
286+ * Path to a workspace directory
287+ * Path to a parent workspace directory (will result to selecting all of the
288+ nested workspaces)
289+
290+ When set for the ` npm init ` command, this may be set to the folder of a
291+ workspace which does not yet exist, to create the folder and set it up as a
292+ brand new workspace within the project.
293+
294+ This value is not exported to the environment for child processes.
295+
296+ #### ` workspaces `
297+
298+ * Default: false
299+ * Type: Boolean
300+
301+ Enable running a command in the context of ** all** the configured
302+ workspaces.
303+
304+ This value is not exported to the environment for child processes.
305+
306+ <!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
307+
190308### See Also
191309
192310* [ npm install] ( /commands/npm-install )
0 commit comments