Skip to main content
This section documents the ralphy binary itself — the global flags every verb honors, the JSON / pretty / quiet output modes, the full error code catalog, and end-to-end flows that span multiple verbs. Per-verb flag detail (every option, every argument) is auto-generated from the source under Verbs (auto-generated) — link out from any narrative page when you need exhaustive flag coverage.

​
Start here

CLI overview

Global flags, TTY auto-detection, project auto-detection, the bare-ralphy dashboard, cancellation.

Output modes

Pretty / JSON / NDJSON / quiet — when each fires and how to pipe to jq.

Setup + doctor

First-run wizard, env health check, common remediation paths.

Error catalog

Every E_ code, exit-code class, and the post-v1.0 append-only contract.

​
Verb groups

Project verbs

new, clone, project create/list/show/update/delete, log + timeline.

Resource CRUD

The unified <resource> create/list/show/update/delete shape — brand, persona, ref, template, batch, asset, workspace, profile, config.

Generation verbs

generate {image|video|voiceover|music|sfx|captions} — slot format, ref gate, append-only versioning, dry-run.

Rendering verbs

render, editor, voice, audio, video — HyperFrames pipeline + ffmpeg recipes.

Skills + playbooks

skill install for Claude / Cursor / Codex / Copilot, sentinel merges, scaffolding new skills.

Assets

Pull from the ralphy-assets companion repo: required, pool, examples.

Templates

template list, suggest, use, show — slug resolution and kinds.

Examples

Pull a complete reference project from the companion repo.

Eval + research

eval video <path> post-render QA and research start/add-source/synthesize topic-level deep research.

Models

models list, show, alias — inspect the OpenRouter catalog the CLI ships against.

Env + config

Required env vars, .env precedence, ralphy config keys.

Verbs (auto-generated)

Per-verb pages with every flag, argument, and example — generated from cli/commands/.