This guide helps you get started with Ralph and understand how to configure it effectively for your projects.
A hands-on tutorial that walks you through enabling Ralph on an existing project and running your first autonomous development loop. You'll build a simple CLI todo app from scratch.
Learn which files Ralph creates, which ones you should customize, and how they work together. Includes a complete reference table and explanations of file relationships.
Best practices for writing PROMPT.md, when to use specs/, and how fix_plan.md evolves during development. Includes good and bad examples.
Check out the examples/ directory for complete, realistic project configurations:
- simple-cli-tool - Minimal example showing core Ralph files
- rest-api - Medium complexity with specs/ directory usage
| I want to... | Do this |
|---|---|
| Enable Ralph on an existing project | ralph-enable |
| Import a PRD/requirements doc | ralph-import requirements.md project-name |
| Create a new project from scratch | ralph-setup my-project |
| Start Ralph with monitoring | ralph --monitor |
| Check what Ralph is doing | ralph --status |
- Main README - Full documentation and configuration options
- CONTRIBUTING.md - How to contribute to Ralph
- GitHub Issues - Report bugs or request features