CLI reference
An overview of every HyperFrames CLI command, its purpose, and a link to its dedicated reference page. JSON-mode and human-mode side by side.
The CLI is one binary, nine commands, two output modes. Each command has its own reference page; this is the map.
What you'll learn
- The full command list with deep links to per-command docs
- The difference between human output and
--jsonoutput - Stable exit codes you can branch on from CI or an agent loop
Commands
| Command | Description |
|---|---|
hyperframes init | Scaffold a new project. |
hyperframes preview | Serve a composition with hot reload. |
hyperframes lint | Static analysis. JSON-friendly. |
hyperframes inspect | Dump duration, fps, tracks, deps. |
hyperframes render | Render to video. |
hyperframes add | Install a registry block. |
hyperframes doctor | Diagnose missing deps. |
hyperframes upgrade | Self-update. |
hyperframes browser | Manage the bundled Chromium. |
Two output modes
Every command supports both --human-friendly (spinners, color, ASCII art) and --json (one object per line, machine-parseable). Agents and CI runners should always use --json.
$ hyperframes lint comp.html --human-friendly
comp.html
✗ data-duration must be a positive number
line 4, col 18
⚠ <video> without data-volume defaults to 1.0
line 5, col 3
1 error, 1 warningGlobal flags
| Flag | Purpose |
|---|---|
--json | Emit structured JSON instead of pretty text. |
--quiet | Suppress non-essential output. |
--human-friendly | Show spinners + colors — for humans, not agents. |
--cwd <path> | Run from a different directory. |
--no-cache | Disable the renderer cache. |
Exit codes
| Code | Meaning |
|---|---|
0 | Success |
1 | Generic failure |
2 | Composition lint errors |
3 | Render failed |
4 | Encoder not found |
5 | Browser launch failed |
64+ | Reserved for plugins |
Stable codes mean agents and CI can branch on outcome without parsing strings. They are part of the public API and won't change between minor versions.
Next
hyperframesCLI reference — the full per-command pages- Schema reference — the machine-readable composition spec