AGENTS.md, routes to the install playbook, runs ralphy doctor, walks you through the key wizard, and confirms. You end with a working ralphy invocation and a project ready for the first brief.
The default path — clone + Claude Code
set me upClaude does the rest:
- Runs
which bun,which ffmpeg,which ralphy. Tells you what’s missing. - Installs
bunand/orffmpegfor you (interactive — you confirm each step). - Drops the
ralphybinary onto yourPATHif it isn’t there yet. - Runs
ralphy setupfor the two API keys. You paste each one; the wizard pings the provider to verify before saving. - Runs
ralphy doctorone last time. Greens across the board means you’re ready.
You need Claude Code on your machine for this path. Install it from claude.com/claude-code — free for personal use. Cursor, Copilot, and Codex work too once Ralphy is set up; see Connect your editor.
What you’ll need
git— to clone the repo.- Claude Code (or another supported editor — see Connect your editor).
bunandffmpegon the host. Claude will install them if missing.- An OpenRouter key — covers image, video, LLM, vision, transcription.
- An ElevenLabs key — covers voiceover and music.
Verify
After Claude finishes, run it yourself to confirm:blockers array tells you the exact next command. Tell Claude “ralphy doctor is failing” and it’ll fix it.
Standalone binary (alternative)
If you don’t want to clone the repo — for CI, scripts, or a one-off render — install the binary directly. You still need augc-cli checkout somewhere on disk for templates and asset cache; the wizard asks for its path.
- macOS (brew)
- Linux/macOS (curl)
- npm (cross-platform)
brew upgrade ralphy picks up new releases.ugc-cli checkout (if you don’t have one, git clone https://github.com/alecs5am/ralphy ugc-cli first), accepts each key, pings the provider to verify, and writes them to <project>/.env.
For CI or scripts, drive setup non-interactively:
cat key.txt | ralphy setup -y --openrouter-key -.
Why clone + Claude Code is the default
Ralphy is built around an agent reading playbooks. The repo is the playbook bundle —AGENTS.md, docs/playbooks/, templates/, MODELS.md. When Claude Code opens the repo, it gets the routing table on every turn, picks the right playbook per request, and runs ralphy for every model call. With the standalone binary alone, you have the engine but not the routing — you’d be improvising prompts and skipping the postmortem-validated patterns the repo ships with.
In short: the binary runs commands; the repo carries the intelligence. You want both.
Next
Drop your first brief into chat — head to Your first video.Related
- Your first video — drive a render from chat
- Connect your editor — wire Cursor, Copilot, or Codex if you don’t use Claude Code
- setup & doctor reference — every flag and edge case
- Install playbook — canonical source
- OpenRouter keys and ElevenLabs keys