Merge pull request #619 from snyk/chore/add-exit-statuses-to-cli-help

chore: add exit statuses to cli help text
snyk · Jul 2, 2019 · 22e1423 · 22e1423
2 parents 6cd86de + 7090956
commit 22e1423
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/help/help.txt b/help/help.txt
@@ -99,6 +99,12 @@ Examples:
   $ snyk test --docker ubuntu:18.04 --org=my-team
   $ snyk test --docker app:latest --file=Dockerfile --policy-path=.snyk
 
+Possible exit statuses and their meaning:
+
+  - 0: success, no vulns found
+  - 1: action_needed, vulns found
+  - 2: failure, try to re-run command
+
 Pro tip: use `snyk test` in your test scripts, if a vulnerability is
 found, the process will exit with a non-zero exit code.