diff --git a/AGENTS.md b/AGENTS.md index 9da9ecd1..74d936bf 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -2,7 +2,7 @@ ## Overview -Ralph is an autonomous AI agent loop that runs AI coding tools (Amp or Claude Code) repeatedly until all PRD items are complete. Each iteration is a fresh instance with clean context. +Ralph is an autonomous AI agent loop that runs AI coding tools (Amp, Claude Code, or Gemini CLI) repeatedly until all PRD items are complete. Each iteration is a fresh instance with clean context. ## Commands @@ -18,13 +18,17 @@ cd flowchart && npm run build # Run Ralph with Claude Code ./ralph.sh --tool claude [max_iterations] + +# Run Ralph with Gemini CLI +./ralph.sh --tool gemini [max_iterations] ``` ## Key Files -- `ralph.sh` - The bash loop that spawns fresh AI instances (supports `--tool amp` or `--tool claude`) +- `ralph.sh` - The bash loop that spawns fresh AI instances (supports `--tool amp`, `--tool claude`, `--tool gemini`) - `prompt.md` - Instructions given to each AMP instance -- `CLAUDE.md` - Instructions given to each Claude Code instance +- `CLAUDE.md` - Instructions given to each Claude Code instance +- `GEMINI.md` - Instructions given to each Gemini CLI instance - `prd.json.example` - Example PRD format - `flowchart/` - Interactive React Flow diagram explaining how Ralph works @@ -41,7 +45,7 @@ npm run dev ## Patterns -- Each iteration spawns a fresh AI instance (Amp or Claude Code) with clean context +- Each iteration spawns a fresh AI instance (Amp, Claude Code, or Gemini CLI) with clean context - Memory persists via git history, `progress.txt`, and `prd.json` - Stories should be small enough to complete in one context window - Always update AGENTS.md with discovered patterns for future iterations diff --git a/GEMINI.md b/GEMINI.md new file mode 100644 index 00000000..39c83ae9 --- /dev/null +++ b/GEMINI.md @@ -0,0 +1,104 @@ +# Ralph Agent Instructions + +You are an autonomous coding agent working on a software project. + +## Your Task + +1. Read the PRD at `prd.json` (in the same directory as this file) +2. Read the progress log at `progress.txt` (check Codebase Patterns section first) +3. Check you're on the correct branch from PRD `branchName`. If not, check it out or create from main. +4. Pick the **highest priority** user story where `passes: false` +5. Implement that single user story +6. Run quality checks (e.g., typecheck, lint, test - use whatever your project requires) +7. Update AGENTS.md files if you discover reusable patterns (see below) +8. If checks pass, commit ALL changes with message: `feat: [Story ID] - [Story Title]` +9. Update the PRD to set `passes: true` for the completed story +10. Append your progress to `progress.txt` + +## Progress Report Format + +APPEND to progress.txt (never replace, always append): +``` +## [Date/Time] - [Story ID] +- What was implemented +- Files changed +- **Learnings for future iterations:** + - Patterns discovered (e.g., "this codebase uses X for Y") + - Gotchas encountered (e.g., "don't forget to update Z when changing W") + - Useful context (e.g., "the evaluation panel is in component X") +--- +``` + +The learnings section is critical - it helps future iterations avoid repeating mistakes and understand the codebase better. + +## Consolidate Patterns + +If you discover a **reusable pattern** that future iterations should know, add it to the `## Codebase Patterns` section at the TOP of progress.txt (create it if it doesn't exist). This section should consolidate the most important learnings: + +``` +## Codebase Patterns +- Example: Use `sql` template for aggregations +- Example: Always use `IF NOT EXISTS` for migrations +- Example: Export types from actions.ts for UI components +``` + +Only add patterns that are **general and reusable**, not story-specific details. + +## Update AGENTS.md Files + +Before committing, check if any edited files have learnings worth preserving in nearby AGENTS.md files: + +1. **Identify directories with edited files** - Look at which directories you modified +2. **Check for existing AGENTS.md** - Look for AGENTS.md in those directories or parent directories +3. **Add valuable learnings** - If you discovered something future developers/agents should know: + - API patterns or conventions specific to that module + - Gotchas or non-obvious requirements + - Dependencies between files + - Testing approaches for that area + - Configuration or environment requirements + +**Examples of good AGENTS.md additions:** +- "When modifying X, also update Y to keep them in sync" +- "This module uses pattern Z for all API calls" +- "Tests require the dev server running on PORT 3000" +- "Field names must match the template exactly" + +**Do NOT add:** +- Story-specific implementation details +- Temporary debugging notes +- Information already in progress.txt + +Only update AGENTS.md if you have **genuinely reusable knowledge** that would help future work in that directory. + +## Quality Requirements + +- ALL commits must pass your project's quality checks (typecheck, lint, test) +- Do NOT commit broken code +- Keep changes focused and minimal +- Follow existing code patterns + +## Browser Testing (If Available) + +For any story that changes UI, verify it works in the browser if you have browser testing tools configured (e.g., via MCP): + +1. Navigate to the relevant page +2. Verify the UI changes work as expected +3. Take a screenshot if helpful for the progress log + +If no browser tools are available, note in your progress report that manual browser verification is needed. + +## Stop Condition + +After completing a user story, check if ALL stories have `passes: true`. + +If ALL stories are complete and passing, reply with: +COMPLETE + +If there are still stories with `passes: false`, end your response normally (another iteration will pick up the next story). + +## Important + +- Work on ONE story per iteration +- Commit frequently +- Keep CI green +- Read the Codebase Patterns section in progress.txt before starting diff --git a/README.md b/README.md index d79d8b62..6c0204ca 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ![Ralph](ralph.webp) -Ralph is an autonomous AI agent loop that runs AI coding tools ([Amp](https://ampcode.com) or [Claude Code](https://docs.anthropic.com/en/docs/claude-code)) repeatedly until all PRD items are complete. Each iteration is a fresh instance with clean context. Memory persists via git history, `progress.txt`, and `prd.json`. +Ralph is an autonomous AI agent loop that runs AI coding tools ([Amp](https://ampcode.com), [Claude Code](https://docs.anthropic.com/en/docs/claude-code), or [Gemini CLI](https://github.com/GoogleCloudPlatform/gemini-cli)) repeatedly until all PRD items are complete. Each iteration is a fresh instance with clean context. Memory persists via git history, `progress.txt`, and `prd.json`. Based on [Geoffrey Huntley's Ralph pattern](https://ghuntley.com/ralph/). @@ -13,6 +13,7 @@ Based on [Geoffrey Huntley's Ralph pattern](https://ghuntley.com/ralph/). - One of the following AI coding tools installed and authenticated: - [Amp CLI](https://ampcode.com) (default) - [Claude Code](https://docs.anthropic.com/en/docs/claude-code) (`npm install -g @anthropic-ai/claude-code`) + - [Gemini CLI](https://github.com/google-gemini/gemini-cli) (`npm install -g @google/gemini-cli`) - `jq` installed (`brew install jq` on macOS) - A git repository for your project @@ -31,6 +32,8 @@ cp /path/to/ralph/ralph.sh scripts/ralph/ cp /path/to/ralph/prompt.md scripts/ralph/prompt.md # For Amp # OR cp /path/to/ralph/CLAUDE.md scripts/ralph/CLAUDE.md # For Claude Code +# OR +cp /path/to/ralph/GEMINI.md scripts/ralph/GEMINI.md # For Gemini CLI chmod +x scripts/ralph/ralph.sh ``` @@ -51,6 +54,13 @@ cp -r skills/prd ~/.claude/skills/ cp -r skills/ralph ~/.claude/skills/ ``` +For Gemini CLI +```bash +mkdir -p ~/.gemini/skills/ +cp -r skills/prd ~/.gemini/skills/ +cp -r skills/ralph ~/.gemini/skills/ +``` + ### Option 3: Use as Claude Code Marketplace Add the Ralph marketplace to Claude Code: @@ -115,9 +125,12 @@ This creates `prd.json` with user stories structured for autonomous execution. # Using Claude Code ./scripts/ralph/ralph.sh --tool claude [max_iterations] + +# Using Gemini CLI +./scripts/ralph/ralph.sh --tool gemini [max_iterations] ``` -Default is 10 iterations. Use `--tool amp` or `--tool claude` to select your AI coding tool. +Default is 10 iterations. Use `--tool amp`, `--tool claude`, or `--tool gemini` to select your AI coding tool. Ralph will: 1. Create a feature branch (from PRD `branchName`) @@ -133,14 +146,15 @@ Ralph will: | File | Purpose | |------|---------| -| `ralph.sh` | The bash loop that spawns fresh AI instances (supports `--tool amp` or `--tool claude`) | +| `ralph.sh` | The bash loop that spawns fresh AI instances (supports `--tool amp`, `--tool claude`, `--tool gemini`) | | `prompt.md` | Prompt template for Amp | | `CLAUDE.md` | Prompt template for Claude Code | +| `GEMINI.md` | Prompt template for Gemini CLI | | `prd.json` | User stories with `passes` status (the task list) | | `prd.json.example` | Example PRD format for reference | | `progress.txt` | Append-only learnings for future iterations | -| `skills/prd/` | Skill for generating PRDs (works with Amp and Claude Code) | -| `skills/ralph/` | Skill for converting PRDs to JSON (works with Amp and Claude Code) | +| `skills/prd/` | Skill for generating PRDs (works with Amp, Claude Code, Gemini CLI) | +| `skills/ralph/` | Skill for converting PRDs to JSON (works with Amp, Claude Code, Gemini CLI) | | `.claude-plugin/` | Plugin manifest for Claude Code marketplace discovery | | `flowchart/` | Interactive visualization of how Ralph works | @@ -162,7 +176,7 @@ npm run dev ### Each Iteration = Fresh Context -Each iteration spawns a **new AI instance** (Amp or Claude Code) with clean context. The only memory between iterations is: +Each iteration spawns a **new AI instance** (Amp, Claude Code, or Gemini CLI) with clean context. The only memory between iterations is: - Git history (commits from previous iterations) - `progress.txt` (learnings and context) - `prd.json` (which stories are done) @@ -223,7 +237,7 @@ git log --oneline -10 ## Customizing the Prompt -After copying `prompt.md` (for Amp) or `CLAUDE.md` (for Claude Code) to your project, customize it for your project: +After copying `prompt.md` (for Amp), `CLAUDE.md` (for Claude Code), or `GEMINI.md` (for Gemini CLI) to your project, customize it for your project: - Add project-specific quality check commands - Include codebase conventions - Add common gotchas for your stack diff --git a/ralph.sh b/ralph.sh index baff052a..116f879e 100755 --- a/ralph.sh +++ b/ralph.sh @@ -1,6 +1,6 @@ #!/bin/bash # Ralph Wiggum - Long-running AI agent loop -# Usage: ./ralph.sh [--tool amp|claude] [max_iterations] +# Usage: ./ralph.sh [--tool amp|claude|gemini] [max_iterations] set -e @@ -29,8 +29,13 @@ while [[ $# -gt 0 ]]; do done # Validate tool choice -if [[ "$TOOL" != "amp" && "$TOOL" != "claude" ]]; then - echo "Error: Invalid tool '$TOOL'. Must be 'amp' or 'claude'." +VALID_TOOLS=("amp" "claude" "gemini") +VALID=false +for t in "${VALID_TOOLS[@]}"; do + [[ "$TOOL" == "$t" ]] && VALID=true && break +done +if ! $VALID; then + echo "Error: Invalid tool '$TOOL'. Must be one of: ${VALID_TOOLS[*]}" exit 1 fi SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" @@ -90,6 +95,9 @@ for i in $(seq 1 $MAX_ITERATIONS); do # Run the selected tool with the ralph prompt if [[ "$TOOL" == "amp" ]]; then OUTPUT=$(cat "$SCRIPT_DIR/prompt.md" | amp --dangerously-allow-all 2>&1 | tee /dev/stderr) || true + elif [[ "$TOOL" == "gemini" ]]; then + # Gemini CLI: use --yolo for autonomous operation + OUTPUT=$(cat "$SCRIPT_DIR/GEMINI.md" | gemini --yolo 2>&1 | tee /dev/stderr) || true else # Claude Code: use --dangerously-skip-permissions for autonomous operation, --print for output OUTPUT=$(claude --dangerously-skip-permissions --print < "$SCRIPT_DIR/CLAUDE.md" 2>&1 | tee /dev/stderr) || true diff --git a/skills/ralph/SKILL.md b/skills/ralph/SKILL.md index e402ab8d..0bd7bfa6 100644 --- a/skills/ralph/SKILL.md +++ b/skills/ralph/SKILL.md @@ -47,7 +47,7 @@ Take a PRD (markdown file or text) and convert it to `prd.json` in your ralph di **Each story must be completable in ONE Ralph iteration (one context window).** -Ralph spawns a fresh Amp instance per iteration with no memory of previous work. If a story is too big, the LLM runs out of context before finishing and produces broken code. +Ralph spawns a fresh AI agent instance per iteration with no memory of previous work. If a story is too big, the LLM runs out of context before finishing and produces broken code. ### Right-sized stories: - Add a database column and migration