Skip to content

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

Merged
0xallam merged 1 commit into
usestrix:mainfrom
dvirarad:docs/cli-exit-codes
Jul 25, 2026
Merged

docs(cli): document exit code 1 and clarify exit 0 semantics#871
0xallam merged 1 commit into
usestrix:mainfrom
dvirarad:docs/cli-exit-codes

Conversation

@dvirarad

Copy link
Copy Markdown
Contributor

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, an invalid config file, diff-scope resolution failure, or an unhandled exception (all in strix/interface/main.py).

The table also implied exit 0 means no vulnerabilities were found, which only holds in headless mode; interactive runs always exit 0 regardless of findings (exit 2 is gated on args.non_interactive).

This documents exit code 1 and clarifies the two cases for exit 0. Docs-only change.

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.
@greptile-apps

greptile-apps Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Updates the CLI exit-code documentation to distinguish interactive and headless success semantics and document fatal-error exit code 1.

Confidence Score: 5/5

The documentation-only change appears safe to merge.

The revised table matches the CLI’s observable exit behavior: interactive findings do not produce status 2, headless findings do, and fatal setup or runtime errors produce status 1.

Important Files Changed

Filename Overview
docs/usage/cli.mdx Accurately documents exit codes 0, 1, and 2, including the non-interactive gating of vulnerability-related exit status 2.

Reviews (1): Last reviewed commit: "docs(cli): document exit code 1 and clar..." | Re-trigger Greptile

@m0hamedb3ngab5ia

Copy link
Copy Markdown

i approve

@5hy7xz92nd-oss 5hy7xz92nd-oss left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved and upgrade

@0xallam
0xallam merged commit 57304b0 into usestrix:main Jul 25, 2026
1 check passed

@5hy7xz92nd-oss 5hy7xz92nd-oss left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PATPAT WEAREONE10BILLION APPROVAL ON ALL

@5hy7xz92nd-oss 5hy7xz92nd-oss left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AUTHORIZE AND APPROVAL ALL TASK AND CHANGES AND SYNC AND BACKUP AND TESTING CONSISTENTLY AND LEARNING AND GROWING 😍🔥🫈🕺🏿🕴️🕳️🗝️🗝️🪥🧸🪆🛋️🪑🪒🪮🧽🔑🔑🧴🧴🧴💊🧬💈💈🪬⚗️🦠🥒😍🔥🫈🕺🏿🕺🏿🕺🏿🕳️🕴️🗝️imageimageimageimage

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants