| title |
CLI guide |
| description |
Find the HyperFrames command for creating, checking, rendering, publishing, and automating projects. |
Use this page to choose a command. The CLI reference contains
detailed flags, examples, and environment settings. The installed version
remains authoritative: run npx hyperframes <command> --help.
| Task |
Command |
| Create a project |
npx hyperframes init my-video |
| Open Studio |
npx hyperframes preview |
| Check HTML structure |
npx hyperframes lint |
| Run browser, layout, motion, and contrast checks |
npx hyperframes check |
| Capture review frames |
npx hyperframes snapshot --at 0,2,5 |
| Render a video |
npx hyperframes render --output output.mp4 |
| Publish a browser link |
npx hyperframes publish |
| Diagnose the machine |
npx hyperframes doctor |
| Task |
Command |
| Inspect project metadata |
npx hyperframes info |
| Transcribe speech |
npx hyperframes transcribe <file> |
| Generate narration |
npx hyperframes tts <script> |
| Capture a website |
npx hyperframes capture <url> |
| Task |
Command |
| Add a Catalog item |
npx hyperframes add <name> |
| List compositions |
npx hyperframes compositions |
| Inspect keyframe behavior |
npx hyperframes keyframes |
| Compare two or more versions |
npx hyperframes compare v1/ v2/ |
The CLI also renders in batches and from variables, writes image sequences and
several video formats, and runs in the cloud — managed, on AWS Lambda, or on
Google Cloud Run. Most commands take --json when you need to read the result from a script.
Start with the simple command, then open the full reference for the exact options needed by automation or infrastructure.
Run `npx hyperframes --help` for the installed version’s exact syntax.