Skip to content

Update README for simplified CLI and stopping conditions#40

Merged
johnnygreco merged 1 commit intomainfrom
update-readme-2
Mar 22, 2026
Merged

Update README for simplified CLI and stopping conditions#40
johnnygreco merged 1 commit intomainfrom
update-readme-2

Conversation

@johnnygreco
Copy link
Copy Markdown
Owner

@johnnygreco johnnygreco commented Mar 22, 2026

Summary

  • Remove references to deleted commands (fix, research, plan, big-swing) and their task templates — only build remains as a named subcommand
  • Fix template links that used absolute local paths instead of relative GitHub-friendly paths
  • Add new Stopping Conditions section documenting --max-cost, --max-duration, --completion-consensus, --verify, and --verify-timeout
  • Add Resuming Runs section documenting --resume-run
  • Update config examples with new keys: max_cost, max_duration_seconds, completion_consensus, verify_command, verify_timeout, timeout_seconds, idle_timeout_seconds, cleanup_on_error
  • Fix background jobs example that still referenced big-swing

Test plan

  • Verify all links in the README resolve correctly on GitHub
  • Confirm documented CLI flags match ralphkit build --help and ralphkit loop --help

The CLI was simplified to a single `build` subcommand (removing `fix`,
`research`, `plan`, and `big-swing`), and loop stopping conditions were
added. This updates the README to match the current state:

- Remove references to deleted commands and task templates
- Fix template paths (absolute local paths → relative)
- Document stopping conditions (max-cost, max-duration, verify, etc.)
- Document --resume-run for resuming previous runs
- Add missing config keys (timeouts, cleanup_on_error, etc.)
@johnnygreco johnnygreco merged commit cd4a6e1 into main Mar 22, 2026
4 checks passed
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.

1 participant