docs(cli): complete CLI exit codes documentation in docs/cli.md (#107) - #277
Merged
himanshu231204 merged 1 commit intoAug 8, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the CLI reference documentation to fully describe the exit codes that oaeval can return, aligning the docs with the CLI’s actual error-to-exit-code mapping so scripts and CI/CD pipelines can reliably interpret outcomes.
Changes:
- Adds a short introductory sentence explaining the purpose of the exit code table.
- Updates the exit code table to include code
6for “Corpus error”. - Refines the description for exit code
1to “General or runtime error”.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
🎉 Congratulations @PrinceThummar011! Your pull request has been successfully merged into main. 🚀 Thank you for contributing to OpenAgentHQ and helping improve the project. We truly appreciate your contribution and hope to see you back with more amazing PRs! Happy Open Sourcing! ❤️ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Completes the CLI exit codes documentation in
docs/cli.mdper issue #107, ensuringscripts and CI/CD pipelines have accurate, complete reference for command exit statuses.
Problem
While
docs/cli.mdalready contained a partial exit codes table (0–5), it was missing:6(CorpusError), which is actively used in the codebaseChanges
6(Corpus error) to the exit codes table, sourced directly fromthe
_ERROR_CODESmapping inopenagent_eval/cli/main.pycodes so scripts and CI/CD pipelines can check command results."
Verification
_ERROR_CODESinopenagent_eval/cli/main.py--version→022uv run mkdocs build— docs build passes cleanlyuv run pytest tests/unit/test_cli/— 107/107 tests passingNotes
A prior claim on this issue reported the exit codes table already existed. This PR
verifies that claim against the source code and closes the remaining gap (missing
code 6 and context line) rather than duplicating existing work.
Closes #107