diff options
| author | Emilis Dambauskas (Tokenmill) <emilis.dambauskas@tokenmill.lt> | 2019-01-09 12:59:47 +0300 |
|---|---|---|
| committer | Kat Marchán <kzm@zkat.tech> | 2019-02-19 01:42:36 +0300 |
| commit | 433020ead5251b562bc3b0f5f55341a5b8cc9023 (patch) | |
| tree | 9a74ea1dc3cfa0e4b6154e1baf17e9ae76a5cfa4 /doc | |
| parent | a805a95ad8832ef5008671f4bd4c11b83e32e0f2 (diff) | |
docs: described exit codes in npm-audit docs
PR-URL: https://github.com/npm/cli/pull/135
Credit: @emilis-tm
Reviewed-By: @zkat
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cli/npm-audit.md | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/cli/npm-audit.md b/doc/cli/npm-audit.md index 4c6d71741..f63bbd356 100644 --- a/doc/cli/npm-audit.md +++ b/doc/cli/npm-audit.md @@ -65,7 +65,8 @@ $ npm audit --parseable | awk -F $'\t' '{print $1,$4}' 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. The report returned includes instructions on how to act on -this information. +this information. The command will exit with a 0 exit code if no +vulnerabilities were found. You can also have npm automatically fix the vulnerabilities by running `npm audit fix`. Note that some vulnerabilities cannot be fixed automatically and @@ -99,6 +100,13 @@ The non-reversible identifiers are a sha256 of a session-specific UUID and the value being replaced, ensuring a consistent value within the payload that is different between runs. +## EXIT CODE + +The `npm audit` command will exit with a 0 exit code if no vulnerabilities were found. + +If vulnerabilities were found the exit code will depend on the `audit-level` +configuration setting. + ## SEE ALSO * npm-install(1) |