docs: improve README scannability and document the exit-code contract#150
Merged
Conversation
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.
Improves README scannability and documents the CLI's stable exit-code contract, inspired by a side-by-side review of coder/boo's README.
What changed
README.md
Quickstart · Why · How it works · Commands · Contributing).--helpself-discoverability and the new exit-code reference.docs/USAGE.md
0–11mapping fromsrc/cli/exitCodes.ts, plusbatchfail-fast /--keep-goingsemantics.waitsection: a standalonewaitthat times out exits0withtimedOut: truein the JSON result; exit code11(WAIT_TIMEOUT) only surfaces from a timed-outwaitstep inside a fail-fastbatch. Callers must check the envelope, not the exit code.src/cli/exitCodes.ts
docs/USAGE.md, so code and docs don't drift.No behavior changes — docs plus one source comment.
Validation
mise run ci(format check, lint, typecheck, tests).AGENT_TTY_HOME: usage error →2, session not found →3, destroy →0, already destroyed →4, and standalonewaittimeout →0with{"matched": false, "timedOut": true}in the envelope (which is why the docs describe11as batch-only — confirmed insrc/batch/executor.tsandtest/integration/batch.test.ts).Note for maintainers
The standalone-
wait-exits-0-on-timeout behavior is now documented as-is, not changed. If you'd rather standalonewaitalso exit non-zero on timeout (sowait ... && next-stepfails closed), that's a breaking CLI change worth its own issue.Generated with
mux• Model:anthropic:claude-fable-5• Thinking:xhigh