Skip to content

Update README examples to reflect intended usage #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Crazytieguy merged 2 commits into from
Mar 8, 2026
Merged

Update README examples to reflect intended usage #48

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a651737
Update README examples to reflect intended usage patterns
github-actions[bot] Feb 24, 2026
7db01da
Address review feedback on README examples
github-actions[bot] Feb 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,9 @@ The native Claude Code TUI is resource-heavy, blocks on permission prompts, and
## Quick Start

```bash
coven "explain this codebase" # one-shot prompt
coven # interactive (type prompt at stdin)
coven ralph "fix lint warnings" # loop until done
coven init && coven worker # orchestration
coven "explain this codebase" # single session — Alt+Enter to follow up
coven ralph "pick one task from TODO.md, do it, check it off"
coven init && coven worker # multi-agent orchestration from brief.md
```

## Commands
Expand Down Expand Up @@ -80,7 +79,16 @@ All session commands (`coven`, `ralph`, `worker`) accept:

## Orchestration

`coven init` + `coven worker` enable multi-agent orchestration. Workers run a generic agent loop: dispatch reads `brief.md` and picks tasks, then chains through main and review agents via `<next>` transitions. See `.coven/system.md` after init for details.
`coven init` + `coven worker` enable multi-agent orchestration. Write tasks in `brief.md`, then start workers:

```markdown
# Brief
Choose between two activities:
- Inspect program output across test scenarios and document issues in issues.md
- Pick up an issue from issues.md and do it
```
Comment on lines +84 to +89
Copy link
Copy Markdown
Owner

@Crazytieguy Crazytieguy Feb 24, 2026

Choose a reason for hiding this comment

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

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


Workers run a generic agent loop: dispatch reads `brief.md` and picks tasks, then chains through main and review agents via `<next>` transitions. Run multiple workers for parallel execution. See `.coven/system.md` after init for details.

## License

Expand Down