Getting Started
Installation
Install CORAL and its dependencies.
Prerequisites
- Python 3.11+
- uv — fast Python package manager (install uv)
- git — for worktree management
- tmux — recommended for session management (CORAL auto-wraps in tmux by default)
You'll also need at least one supported agent runtime:
- Claude Code (default) — requires an Anthropic API key
- Codex — OpenAI's coding agent
- OpenCode — open-source alternative
Install from source
git clone https://github.com/yanyh528/CORAL.git
cd CORALBasic install
uv syncWith development tools
uv sync --extra dev # pytest, ruff, mypyEverything
uv sync --all-extras # All optional dependenciesVerify installation
coral --versionYou should see something like coral 0.2.0.
Optional dependencies
Some grader types require additional packages:
| Feature | Install |
|---|---|
| SWE-bench grading | uv sync --extra swebench |
| TerminalBench | uv sync --extra terminalbench |
| Erdős problems | uv sync --extra erdos |
| Web dashboard | uv sync --extra ui |
Next steps
Once installed, head to the Quick Start to run your first task.