npm audit [--json] [--production] [--audit-level=(low|moderate|high|critical)]npm audit fix [--force|--package-lock-only|--dry-run|--production|--only=(dev|prod)]common options: [--production] [--only=(dev|prod)]
The audit command submits a description of the dependencies configured in
your project to your default registry and asks for a report of known
vulnerabilities. If any vulnerabilities are found, then the impact and
appropriate remediation will be calculated. If the
fix argument is
provided, then remediations will be applied to the package tree.
The command will exit with a 0 exit code if no vulnerabilities were found.
Note that some vulnerabilities cannot be fixed automatically and will
require manual intervention or review. Also note that since
fix runs a full-fledged
npm install under the hood, all configs that
apply to the installer will also apply to
npm install -- so things like
npm audit fix --package-lock-only will work as expected.
By default, the audit command will exit with a non-zero code if any
vulnerability is found. It may be useful in CI environments to include the
--audit-level parameter to specify the minimum vulnerability level that
will cause the command to fail. This option does not filter the report
output, it simply changes the command's failure threshold.
There are two audit endpoints that npm may use to fetch vulnerability
Bulk Advisory endpoint and the
Quick Audit endpoint.
As of version 7, npm uses the much faster
Bulk Advisory endpoint to
optimize the speed of calculating audit results.
npm will generate a JSON payload with the name and list of versions of each
package in the tree, and POST it to the default configured registry at
Any packages in the tree that do not have a
version field in their
package.json file will be ignored. If any
--omit options are specified
(either via the
--omit config, or one of the shorthands such as
--only=dev, and so on), then packages will be omitted
from the submitted payload as appropriate.
If the registry responds with an error, or with an invalid response, then
npm will attempt to load advisory data from the
Quick Audit endpoint.
The expected result will contain a set of advisory objects for each
dependency that matches the advisory range. Each advisory object contains
npm then uses these advisory objects to calculate vulnerabilities and meta-vulnerabilities of the dependencies within the tree.
Bulk Advisory endpoint returns an error, or invalid data, npm will
attempt to load advisory data from the
Quick Audit endpoint, which is
considerably slower in most cases.
The full package tree as found in
package-lock.json is submitted, along
with the following pieces of additional metadata:
All packages in the tree are submitted to the Quick Audit endpoint. Omitted dependency types are skipped when generating the report.
Out of an abundance of caution, npm versions 5 and 6 would "scrub" any
packages from the submitted report if their name contained a
so as to avoid leaking the names of potentially private packages or git
However, in practice, this resulted in audits often failing to properly detect meta-vulnerabilities, because the tree would appear to be invalid due to missing dependencies, and prevented the detection of vulnerabilities in package trees that used git dependencies or private modules.
This scrubbing has been removed from npm as of version 7.
npm uses the
module to turn a set of security advisories into a set of "vulnerability"
objects. A "meta-vulnerability" is a dependency that is vulnerable by
virtue of dependence on vulnerable versions of a vulnerable package.
For example, if the package
foo is vulnerable in the range
<2.0.0, and the package
bar depends on
foo@^1.1.0, then that version
bar can only be installed by installing a vulnerable version of
In this case,
bar is a "metavulnerability".
Once metavulnerabilities for a given package are calculated, they are
cached in the
~/.npm folder and only re-evaluated if the advisory range
changes, or a new version of the package is published (in which case, the
new version is checked for metavulnerable status as well).
If the chain of metavulnerabilities extends all the way to the root
project, and it cannot be updated without changing its dependency ranges,
npm audit fix will require the
--force option to apply the
remediation. If remediations do not require changes to the dependency
ranges, then all vulnerable packages will be updated to a version that does
not have an advisory or metavulnerability posted against it.
npm audit command will exit with a 0 exit code if no vulnerabilities
were found. The
npm audit fix command will exit with 0 exit code if no
vulnerabilities are found or if the remediation is able to successfully
fix all vulnerabilities.
If vulnerabilities were found the exit code will depend on the
audit-level configuration setting.
Scan your project for vulnerabilities and automatically install any compatible updates to vulnerable dependencies:
$ npm audit fix
audit fix without modifying
node_modules, but still updating the
$ npm audit fix --package-lock-only
$ npm audit fix --only=prod
audit fix install SemVer-major updates to toplevel dependencies, not
just SemVer-compatible ones:
$ npm audit fix --force
Do a dry run to get an idea of what
audit fix will do, and also output
install information in JSON format:
$ npm audit fix --dry-run --json
Scan your project for vulnerabilities and just show the details, without fixing anything:
$ npm audit
Get the detailed audit report in JSON format:
$ npm audit --json
Fail an audit only if the results include a vulnerability with a level of moderate or higher:
$ npm audit --audit-level=moderate