docs(cli): document exit code 1 and clarify exit 0 semantics

The Exit Codes table in the CLI reference only listed 0 and 2, but the
CLI also exits with 1 on fatal errors (missing environment variables,
Docker unavailable, invalid config file, diff-scope resolution failure,
or an unhandled exception). It also implied exit 0 means no
vulnerabilities were found, which is only true in headless mode -
interactive runs always exit 0 regardless of findings.

Document exit code 1 and clarify the two cases for exit 0.
This commit is contained in:
dvir arad
2026-07-25 05:29:13 -07:00
committed by Ahmed Allam
parent cd8270c98b
commit 57304b0084
+2 -1
View File
@@ -116,5 +116,6 @@ strix --mount ./huge-monorepo
| Code | Meaning |
|------|---------|
| 0 | Scan completed, no vulnerabilities found |
| 0 | Scan completed successfully (interactive mode always exits `0`; in headless mode, `0` means no vulnerabilities were found) |
| 1 | A fatal error occurred before or during the scan (e.g. missing environment variables, Docker unavailable, invalid config file, diff-scope resolution failure, or an unhandled error) |
| 2 | Vulnerabilities found (headless mode only) |