Update README examples to reflect intended usage#48
Merged
Crazytieguy merged 2 commits intomainfrom Mar 8, 2026
Merged
Conversation
Quick Start examples are now grounded in real test cases: ralph shows the TODO.md iteration pattern, interactive mode highlights Alt+Enter follow-ups, and orchestration references brief.md. The Orchestration section now includes a concrete brief.md example from the concurrent_workers test fixture. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Closed
Crazytieguy
requested changes
Feb 24, 2026
README.md
Outdated
| coven # interactive (type prompt at stdin) | ||
| coven ralph "fix lint warnings" # loop until done | ||
| coven init && coven worker # orchestration | ||
| coven # interactive — Alt+Enter to follow up |
Owner
There was a problem hiding this comment.
Alt+Enter isn't unique to this mode, and tbh I don't like framing it as "interactive" to begin with. Maybe let's just merge with the coven "prompt" example and call it "single session"
Comment on lines
+85
to
+89
| ```markdown | ||
| # Brief | ||
| - Fix the typo in README.md: change "Helo" to "Hello" | ||
| - Create a CONTRIBUTING.md with a "how to contribute" section | ||
| ``` |
Owner
There was a problem hiding this comment.
I'd like to change this from a fixed list of todos to something more scalable, which I've been using it for. choose between two activities: inspect program output across test scenarios and document issues in issues.md, or pick up an issue from issues.md and do it. This demonstrates the power of more hands off agent orchestration
Author
|
Review feedback addressed and pushed.
Changes made:
|
- Merge interactive/one-shot into single "single session" example - Replace fixed todo list with scalable inspect/fix orchestration pattern Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
1 participant
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
ralph_breaktest case instead of generic "fix lint warnings"brief.mdas the interfacebrief.mdexample (taken from theconcurrent_workerstest fixture) so users immediately see the expected formatCloses #47
Test plan
cargo fmt— cleancargo clippy— cleancargo test— all 150 tests pass🤖 Generated with Claude Code