summaryrefslogtreecommitdiff
path: root/deps/npm/doc/cli/npm-audit.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/doc/cli/npm-audit.md')
-rw-r--r--deps/npm/doc/cli/npm-audit.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/deps/npm/doc/cli/npm-audit.md b/deps/npm/doc/cli/npm-audit.md
index 3bb13259d7..4c6d717418 100644
--- a/deps/npm/doc/cli/npm-audit.md
+++ b/deps/npm/doc/cli/npm-audit.md
@@ -3,7 +3,7 @@ npm-audit(1) -- Run a security audit
## SYNOPSIS
- npm audit [--json]
+ npm audit [--json|--parseable]
npm audit fix [--force|--package-lock-only|--dry-run|--production|--only=dev]
## EXAMPLES
@@ -48,6 +48,18 @@ Get the detailed audit report in JSON format:
$ npm audit --json
```
+Get the detailed audit report in plain text result, separated by tab characters, allowing for
+future reuse in scripting or command line post processing, like for example, selecting
+some of the columns printed:
+```
+$ npm audit --parseable
+```
+
+To parse columns, you can use for example `awk`, and just print some of them:
+```
+$ npm audit --parseable | awk -F $'\t' '{print $1,$4}'
+```
+
## DESCRIPTION
The audit command submits a description of the dependencies configured in