# Ralph Orchestrator

> Hat-based orchestration framework that keeps AI agents in a loop until the task is done

Ralph Orchestrator is a hat-based orchestration framework for autonomous AI agents. This llms.txt provides an LLM-friendly map of the most important project documentation.


## Getting Started

- [Getting Started](https://mikeyobrien.github.io/ralph-orchestrator/getting-started/index.md): Start here for first-time setup and orientation.
- [Installation](https://mikeyobrien.github.io/ralph-orchestrator/getting-started/installation/index.md): Installation methods and prerequisites.
- [Quick Start](https://mikeyobrien.github.io/ralph-orchestrator/getting-started/quick-start/index.md): Fast path to running Ralph.
- [Your First Task](https://mikeyobrien.github.io/ralph-orchestrator/getting-started/first-task/index.md): First end-to-end task walkthrough.

## Concepts

- [Concepts](https://mikeyobrien.github.io/ralph-orchestrator/concepts/index.md): Concept overview and mental model.
- [The Ralph Wiggum Technique](https://mikeyobrien.github.io/ralph-orchestrator/concepts/ralph-wiggum-technique/index.md)
- [The Six Tenets](https://mikeyobrien.github.io/ralph-orchestrator/concepts/tenets/index.md)
- [Hats & Events](https://mikeyobrien.github.io/ralph-orchestrator/concepts/hats-and-events/index.md)
- [Coordination Patterns](https://mikeyobrien.github.io/ralph-orchestrator/concepts/coordination-patterns/index.md)
- [Memories & Tasks](https://mikeyobrien.github.io/ralph-orchestrator/concepts/memories-and-tasks/index.md)
- [Backpressure](https://mikeyobrien.github.io/ralph-orchestrator/concepts/backpressure/index.md)

## User Guide

- [User Guide](https://mikeyobrien.github.io/ralph-orchestrator/guide/index.md)
- [Configuration](https://mikeyobrien.github.io/ralph-orchestrator/guide/configuration/index.md)
- [Presets](https://mikeyobrien.github.io/ralph-orchestrator/guide/presets/index.md)
- [CLI Reference](https://mikeyobrien.github.io/ralph-orchestrator/guide/cli-reference/index.md)
- [Backends](https://mikeyobrien.github.io/ralph-orchestrator/guide/backends/index.md)
- [Writing Prompts](https://mikeyobrien.github.io/ralph-orchestrator/guide/prompts/index.md)
- [Cost Management](https://mikeyobrien.github.io/ralph-orchestrator/guide/cost-management/index.md)

## Advanced

- [Advanced Topics](https://mikeyobrien.github.io/ralph-orchestrator/advanced/index.md)
- [Architecture](https://mikeyobrien.github.io/ralph-orchestrator/advanced/architecture/index.md)
- [Creating Custom Hats](https://mikeyobrien.github.io/ralph-orchestrator/advanced/custom-hats/index.md)
- [Event System Design](https://mikeyobrien.github.io/ralph-orchestrator/advanced/event-system/index.md)
- [Memory System](https://mikeyobrien.github.io/ralph-orchestrator/advanced/memory-system/index.md)
- [Task System](https://mikeyobrien.github.io/ralph-orchestrator/advanced/task-system/index.md)
- [Testing & Validation](https://mikeyobrien.github.io/ralph-orchestrator/advanced/testing/index.md)
- [Diagnostics](https://mikeyobrien.github.io/ralph-orchestrator/advanced/diagnostics/index.md)
- [Parallel Loops](https://mikeyobrien.github.io/ralph-orchestrator/advanced/parallel-loops/index.md)
- [Agent Waves](https://mikeyobrien.github.io/ralph-orchestrator/advanced/agent-waves/index.md)

## API Reference

- [API Reference](https://mikeyobrien.github.io/ralph-orchestrator/api/index.md)
- [ralph-proto](https://mikeyobrien.github.io/ralph-orchestrator/api/ralph-proto/index.md)
- [ralph-core](https://mikeyobrien.github.io/ralph-orchestrator/api/ralph-core/index.md)
- [ralph-adapters](https://mikeyobrien.github.io/ralph-orchestrator/api/ralph-adapters/index.md)
- [ralph-tui](https://mikeyobrien.github.io/ralph-orchestrator/api/ralph-tui/index.md)
- [ralph-cli](https://mikeyobrien.github.io/ralph-orchestrator/api/ralph-cli/index.md)

## Examples

- [Examples](https://mikeyobrien.github.io/ralph-orchestrator/examples/index.md)
- [Simple Task](https://mikeyobrien.github.io/ralph-orchestrator/examples/simple-task/index.md)
- [TDD Workflow](https://mikeyobrien.github.io/ralph-orchestrator/examples/tdd-workflow/index.md)
- [Spec-Driven Development](https://mikeyobrien.github.io/ralph-orchestrator/examples/spec-driven/index.md)
- [Multi-Hat Workflow](https://mikeyobrien.github.io/ralph-orchestrator/examples/multi-hat/index.md)
- [Debugging](https://mikeyobrien.github.io/ralph-orchestrator/examples/debugging/index.md)

## Contributing

- [Contributing to Ralph](https://mikeyobrien.github.io/ralph-orchestrator/contributing/index.md)
- [Development Setup](https://mikeyobrien.github.io/ralph-orchestrator/contributing/setup/index.md)
- [Code Style](https://mikeyobrien.github.io/ralph-orchestrator/contributing/style/index.md)
- [Testing](https://mikeyobrien.github.io/ralph-orchestrator/contributing/testing/index.md)
- [Submitting PRs](https://mikeyobrien.github.io/ralph-orchestrator/contributing/pull-requests/index.md)

## Reference

- [Reference](https://mikeyobrien.github.io/ralph-orchestrator/reference/index.md)
- [Changelog](https://mikeyobrien.github.io/ralph-orchestrator/reference/changelog/index.md)
- [FAQ](https://mikeyobrien.github.io/ralph-orchestrator/reference/faq/index.md)
- [Glossary](https://mikeyobrien.github.io/ralph-orchestrator/reference/glossary/index.md)
- [Migration from v1](https://mikeyobrien.github.io/ralph-orchestrator/reference/migration-v1/index.md)
- [Troubleshooting](https://mikeyobrien.github.io/ralph-orchestrator/reference/troubleshooting/index.md)