Skip to content

Commit

Permalink
Document yarn audit --groups
Browse files Browse the repository at this point in the history
Basic doc for  yarn audit --groups command introduced byhttps://github.com/yarnpkg/yarn/pull/6724
  • Loading branch information
sarod committed Mar 3, 2020
1 parent ec0ed0b commit 9dec253
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion lang/en/docs/cli/audit.md
Expand Up @@ -8,7 +8,7 @@ layout: guide

<p class="lead">Perform a vulnerability audit against the installed packages.</p>

##### `yarn audit [--verbose] [--json] [--level]` <a class="toc" id="toc-yarn-audit" href="#toc-yarn-audit"></a>
##### `yarn audit [--verbose] [--json] [--level] [--groups]` <a class="toc" id="toc-yarn-audit" href="#toc-yarn-audit"></a>

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

Expand All @@ -33,3 +33,8 @@ For scripting purposes, `yarn audit` also supports the `--json` flag, which will
##### `yarn audit [--level info|low|moderate|high|critical]` <a class="toc" id="toc-yarn-add" href="#toc-yarn-add"></a>

Applying the level flag will limit the audit table to vulnerabilities of the corresponding level and above. It will *not* affect the exit code of the command.


##### `yarn audit [--groups group_name ...]` <a class="toc" id="toc-yarn-add" href="#toc-yarn-add"></a>

Applying the groups flag will limit the audit table to vulnerabilities of the corresponding dependency groups (e.g dependencies,devDependencies).

0 comments on commit 9dec253

Please sign in to comment.