ralph README

The project's README from github.com/snarktank/ralph. As one markdown file: README.md.

Ralph

Ralph

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. Memory persists via git history, progress.txt, and prd.json.

Based on Geoffrey Huntley's Ralph pattern.

Read my in-depth article on how I use Ralph

Prerequisites

Setup

Option 1: Copy to your project

Copy the ralph files into your project:

# From your project root
mkdir -p scripts/ralph
cp /path/to/ralph/ralph.sh scripts/ralph/

# Copy the prompt template for your AI tool of choice:
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

chmod +x scripts/ralph/ralph.sh

Option 2: Install skills globally (Amp)

Copy the skills to your Amp or Claude config for use across all projects:

For AMP

cp -r skills/prd ~/.config/amp/skills/
cp -r skills/ralph ~/.config/amp/skills/

For Claude Code (manual)

cp -r skills/prd ~/.claude/skills/
cp -r skills/ralph ~/.claude/skills/

Option 3: Use as Claude Code Marketplace

Add the Ralph marketplace to Claude Code:

/plugin marketplace add snarktank/ralph

Then install the skills:

/plugin install ralph-skills@ralph-marketplace

Available skills after installation:

Skills are automatically invoked when you ask Claude to:

Add to ~/.config/amp/settings.json:

{
  "amp.experimental.autoHandoff": { "context": 90 }
}

This enables automatic handoff when context fills up, allowing Ralph to handle large stories that exceed a single context window.

Workflow

1. Create a PRD

Use the PRD skill to generate a detailed requirements document:

Load the prd skill and create a PRD for [your feature description]

Answer the clarifying questions. The skill saves output to tasks/prd-[feature-name].md.

2. Convert PRD to Ralph format

Use the Ralph skill to convert the markdown PRD to JSON:

Load the ralph skill and convert tasks/prd-[feature-name].md to prd.json

This creates prd.json with user stories structured for autonomous execution.

3. Run Ralph

# Using Amp (default)
./scripts/ralph/ralph.sh [max_iterations]

# Using Claude Code
./scripts/ralph/ralph.sh --tool claude [max_iterations]

Default is 10 iterations. Use --tool amp or --tool claude to select your AI coding tool.

Ralph will:

  1. Create a feature branch (from PRD branchName)
  2. Pick the highest priority story where passes: false
  3. Implement that single story
  4. Run quality checks (typecheck, tests)
  5. Commit if checks pass
  6. Update prd.json to mark story as passes: true
  7. Append learnings to progress.txt
  8. Repeat until all stories pass or max iterations reached

Key Files

File Purpose
ralph.sh The bash loop that spawns fresh AI instances (supports --tool amp or --tool claude)
prompt.md Prompt template for Amp
CLAUDE.md Prompt template for Claude Code
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)
.claude-plugin/ Plugin manifest for Claude Code marketplace discovery
flowchart/ Interactive visualization of how Ralph works

Flowchart

Ralph Flowchart

View Interactive Flowchart - Click through to see each step with animations.

The flowchart/ directory contains the source code. To run locally:

cd flowchart
npm install
npm run dev

Critical Concepts

Each Iteration = Fresh Context

Each iteration spawns a new AI instance (Amp or Claude Code) with clean context. The only memory between iterations is:

Small Tasks

Each PRD item should be small enough to complete in one context window. If a task is too big, the LLM runs out of context before finishing and produces poor code.

Right-sized stories:

Too big (split these):

AGENTS.md Updates Are Critical

After each iteration, Ralph updates the relevant AGENTS.md files with learnings. This is key because AI coding tools automatically read these files, so future iterations (and future human developers) benefit from discovered patterns, gotchas, and conventions.

Examples of what to add to AGENTS.md:

Feedback Loops

Ralph only works if there are feedback loops:

Browser Verification for UI Stories

Frontend stories must include "Verify in browser using dev-browser skill" in acceptance criteria. Ralph will use the dev-browser skill to navigate to the page, interact with the UI, and confirm changes work.

Stop Condition

When all stories have passes: true, Ralph outputs <promise>COMPLETE</promise> and the loop exits.

Debugging

Check current state:

# See which stories are done
cat prd.json | jq '.userStories[] | {id, title, passes}'

# See learnings from previous iterations
cat progress.txt

# Check git history
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:

Archiving

Ralph automatically archives previous runs when you start a new feature (different branchName). Archives are saved to archive/YYYY-MM-DD-feature-name/.

References

ralph (snarktank/ralph)

Searching Database…

22K ·GitHub
Ralph
What is this?Ralph is an autonomous AI agent loop that runs AI coding tools (Amp or Claude Code) over and over until every item in your PRD is done. Each iteration starts a fresh instance with clean context.
Is this an app I install, or something that lives inside my project?Neither an app nor a service — it's a handful of files: a bash loop (ralph.sh), prompt templates, and skills you copy into your project, install globally, or add via the Claude Code marketplace.
How do I actually use it on a feature?Generate a PRD with the /prd skill, convert it to prd.json with the /ralph skill, then run Ralph — 10 iterations by default, picking the backend with --tool amp or --tool claude.
What do I need to have before I can run it?An authenticated Amp CLI (the default) or Claude Code, jq installed (brew install jq on macOS), and a git repository for your project. That's the whole list.
Can I just throw a big feature at it?No — every PRD item must be small enough to finish within one context window; epics like 'add authentication' or 'build the entire dashboard' are too big and should be split.
How does it handle frontend stories?Frontend stories must include 'Verify in browser using dev-browser skill' in their acceptance criteria. Ralph then uses the dev-browser skill to open the page, interact with the UI, and confirm the change actually works.
What is the Amp auto-handoff setting for?Adding a setting to ~/.config/amp/settings.json enables automatic handoff when context fills up, so Ralph can keep going on large stories that exceed a single context window.
What happens to my previous run when I start a new feature?Ralph automatically archives previous runs when you start a feature with a different branchName, saving them under archive/YYYY-MM-DD-feature-name/.
Where does the approach come from?It's based on Geoffrey Huntley's Ralph pattern, and the repo author wrote an in-depth article on how they use Ralph in their own workflow.
What are similar projects?planning-with-files, operator-memory, codify, autoresearch, orca, pstack-claude, ordewell, deer-flow
Which topics is it in?context-management, agentic-workflow, agentic-coding, bash, autonomous-agents, coding-agents, claude-skills, agent-memory, workflow-automation, prompt-engineering, git, shell
Creator
snarktank
Size
4.6 MB
Stars
22K
Updated
CommitFeb 02
Age
9mo
Commits · 90 Days