feat(docker): add Docker-based Windows and cross-platform support

Enables Ralph to run inside a Docker container for Windows users
(via Docker Desktop) and anyone preferring containerized execution.

New files:
- Dockerfile (Debian slim + Node.js 20 + all Ralph dependencies)
- docker-compose.yml for easy startup
- docker/docker-entrypoint.sh with UID/GID remapping
- docker/ralph-docker (bash wrapper) and ralph-docker.ps1 (PowerShell)
- .gitattributes to prevent Windows CRLF line ending corruption
- .dockerignore for clean build context
- .github/workflows/docker.yml CI workflow
- docs/user-guide/04-docker-setup.md comprehensive documentation

Updated: README.md, CLAUDE.md, docs/user-guide/README.md, .gitignore

https://claude.ai/code/session_01SNzxUdH1Udf26rN3RKNNzu

2026-02-10 20:54:23 +00:00

2 KiB

Raw Blame History

Ralph User Guide

This guide helps you get started with Ralph and understand how to configure it effectively for your projects.

Guides

Quick Start: Your First Ralph Project

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.

Understanding Ralph Files

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.

Writing Effective Requirements

Best practices for writing PROMPT.md, when to use specs/, and how fix_plan.md evolves during development. Includes good and bad examples.

Docker Setup (Windows & Cross-Platform)

Run Ralph inside a Docker container on Windows, Linux, or macOS. Includes Docker Compose setup, file permissions, git integration, and troubleshooting.

Example Projects

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

Quick Reference

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`

Need Help?

Main README - Full documentation and configuration options
CONTRIBUTING.md - How to contribute to Ralph
GitHub Issues - Report bugs or request features

2 KiB Raw Blame History