yarn npm audit

Perform a vulnerability audit against the installed packages.

Usage

$ yarn npm audit

Examples

Checks for known security issues with the installed packages. The output is a list of known issues. :

yarn npm audit

Audit dependencies in all workspaces :

yarn npm audit --all

Limit auditing to dependencies (excludes devDependencies) :

yarn npm audit --environment production

Show audit report as valid JSON :

yarn npm audit --json

Audit all direct and transitive dependencies :

yarn npm audit --recursive

Output moderate (or more severe) vulnerabilities :

yarn npm audit --severity moderate

Exclude certain packages :

yarn npm audit --exclude package1 --exclude package2

Ignore specific advisories :

yarn npm audit --ignore 1234567 --ignore 7654321

Details

This command checks for known security reports on the packages you use. The reports are by default extracted from the npm registry, and may or may not be relevant to your actual program (not all vulnerabilities affect all code paths).

For consistency with our other commands the default is to only check the direct dependencies for the active workspace. To extend this search to all workspaces, use -A,--all. To extend this search to both direct and transitive dependencies, use -R,--recursive.

Applying the --severity flag will limit the audit table to vulnerabilities of the corresponding severity and above. Valid values are info, low, moderate, high, critical.

If the --json flag is set, Yarn will print the output exactly as received from the registry. Regardless of this flag, the process will exit with a non-zero exit code if a report is found for the selected packages.

If certain packages produce false positives for a particular environment, the --exclude flag can be used to exclude any number of packages from the audit. This can also be set in the configuration file with the npmAuditExcludePackages option.

If particular advisories are needed to be ignored, the --ignore flag can be used with Advisory ID's to ignore any number of advisories in the audit report. This can also be set in the configuration file with the npmAuditIgnoreAdvisories option.

To understand the dependency tree requiring vulnerable packages, check the raw report with the --json flag or use yarn why package to get more information as to who depends on them.

Options

Definition	Description
-A,--all	Audit dependencies from all workspaces
-R,--recursive	Audit transitive dependencies as well
--environment #0	Which environments to cover
--json	Format the output as an NDJSON stream
--no-deprecations	Don't warn about deprecated packages
--severity #0	Minimal severity requested for packages to be displayed
--exclude #0	Array of glob patterns of packages to exclude from audit
--ignore #0	Array of glob patterns of advisory ID's to ignore in the audit report