Welcome to pyralph’s documentation!
“I’m helping!” — Ralph Wiggum
pyralph is an autonomous software development agent that iteratively builds projects through a structured three-phase loop. It acts as a self-directing AI assistant that can understand project requirements, create detailed plans, and execute development tasks with built-in verification and error recovery.
Based on Ralph Wiggum as a “Software engineer”.
Tip
“Me fail English? That’s unpossible!” — Just like Ralph, pyralph learns from its mistakes and keeps trying until it gets things right.
Getting Started
New to Ralph? Start here:
Installation - Install pyralph and its dependencies
Quick Start - Get up and running quickly
Concepts - Understand how Ralph works
User Guide:
Reference:
Project Info:
Links:
Key Features
“I bent my Wookiee.” — Ralph breaks things so you don’t have to.
Three-Phase Workflow: Architect -> Planner -> Execute loop for autonomous development
File-based State: All context persisted to
.ralph/directory for session resumabilityVerification Gate: Tasks validated by running actual tests before completion
Retry Mechanism: Failed tasks automatically retry with error feedback
Hook System: Extensible event system for custom integrations
CI/CD Support: Headless mode with JSON output for pipeline integration
Quick Example
# Install pyralph
pip install pyralph
# Start the agent
ralph
# Run with auto-accept mode
ralph --accept-all
# Run specific phase
ralph architect
ralph planner
ralph execute