Use this as a fast reference when you are directing agents, cutting timing, making visual layout tweaks, previewing, and sharing HyperFrames projects.Documentation Index
Fetch the complete documentation index at: https://hyperframes.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
The Fast Loop
index.html or files in compositions/. The Studio updates automatically, so you can direct the agent, scrub the result, make manual visual tweaks, then repeat.
Most production work should feel like this:
- Ask the agent for the first cut, scene, caption pass, transition, or cleanup.
- Use the Studio preview and timeline to check timing.
- Use manual DOM editing for Figma-like layout tweaks: select elements, move them, and adjust visual properties directly.
- Ask the agent to clean up or generalize anything you changed manually.
- Lint, validate, render, and publish.
Terminal Shortcuts
Move around projects quickly:index.html lives. If you are not sure where you are, run pwd then ls. If you see index.html, you are in the right place.
Preview Shortcuts
Start the Studio:3002 is already busy:
| Shortcut | Use |
|---|---|
Space | Play or pause (focus on the page body) |
Left Arrow / Right Arrow | Nudge seek bar by 1 second (seek bar focused) |
Shift+Left Arrow / Shift+Right Arrow | Nudge seek bar by 5 seconds (seek bar focused) |
Shift+T | Show or hide the timeline editor |
Cmd+1 / Ctrl+1 | Switch to Compositions |
Cmd+2 / Ctrl+2 | Switch to Assets |
Delete / Backspace | Delete the selected timeline clip (when not typing in an editor) |
Escape | Leave a sub-composition or close editor dialogs |
Agent-Led Editing
Ask the agent to verify visible changes in the browser. For a user-visible edit, a good handoff is:Manual DOM Editing
In the Studio, you can edit the DOM visually for the final 10% of creative adjustment where dragging is faster than describing. Use manual DOM editing for:- moving titles, captions, product cards, logos, and overlays into position
- adjusting size, spacing, opacity, color, and other visual properties
- checking composition balance at an exact timestamp
- making Figma-like placement tweaks
- creating scenes from scratch
- refactoring repeated visual patterns
- wiring GSAP timelines
- fixing broken timing, layout overflow, or render errors
- turning a manual visual tweak into reusable, clean HTML/CSS
CLI Commands Editors Use Most
| Command | Use it for |
|---|---|
npx hyperframes init my-video | Create a new project |
npx hyperframes init my-video --example warm-grain | Start from a visual template |
npx hyperframes init my-video --video source.mp4 | Import video and generate captions from the source audio |
npx hyperframes capture https://example.com | Capture a website as source material for a video |
npx hyperframes preview | Open the live Studio preview |
npx hyperframes lint | Catch structural mistakes before preview or render |
npx hyperframes validate | Run the composition in headless Chrome to catch runtime errors |
npx hyperframes inspect | Find text overflow and layout problems across the timeline |
npx hyperframes snapshot --at 1,3,5 | Save PNG checks at exact timestamps |
npx hyperframes render --output final.mp4 | Render the video |
npx hyperframes publish | Upload the project and get a shareable HyperFrames URL |
npx hyperframes doctor | Check Node.js, FFmpeg, Chrome, Docker, and other dependencies |
npx hyperframes docs | Open local CLI docs |
npx hyperframes upgrade | Check for a newer CLI version |
Timing Cheatsheet
Every visible timed layer should usually be a clip:| Attribute | Video editor meaning |
|---|---|
data-start | When the layer starts |
data-duration | How long the layer stays active |
data-track-index | Timeline track number |
data-media-start | Offset into a media file |
data-volume | Audio volume for an audio or video clip |
data-composition-src | Nested scene or reusable overlay |
Render Presets
| Goal | Command |
|---|---|
| Fast iteration | npx hyperframes render --quality draft --output draft.mp4 |
| Review link | npx hyperframes render --quality standard --output review.mp4 |
| Final export | npx hyperframes render --quality high --fps 30 --output final.mp4 |
| Transparent overlay | npx hyperframes render --format webm --output overlay.webm |
| Deterministic output | npx hyperframes render --docker --output final.mp4 |
--docker when you need pixel-consistent output across different machines.
Publish and Share
Usepublish when you want to share the editable project, not just the rendered MP4:
hyperframes.dev URL. The URL includes a claim token so the recipient can open it, claim the project, and continue editing in the web app.
index.html at the project root. It ignores .git, node_modules, dist, .next, and coverage.
What Agent Browser Is
agent-browser is a browser automation tool for AI agents. It opens Chrome, navigates to your preview, clicks controls, reads page state, and captures screenshots. It is how an agent proves the video preview actually works instead of only saying the code looks right.
Typical verification flow:
npx hyperframes preview running, then have the agent use agent-browser against the local preview URL.
Quick Fixes
| Problem | Command or check |
|---|---|
| Preview will not start | npx hyperframes doctor |
| Port already in use | npx hyperframes preview --port 4567 |
| Render fails | npx hyperframes lint then npx hyperframes validate |
| Need exact frame checks | npx hyperframes snapshot --at 1,2.5,5 |
| Text overflows in the frame | npx hyperframes inspect |
| Final render is too slow | Try --quality draft, reduce image sizes, or lower --fps |
| Need to share editable project | npx hyperframes publish |
Prompt Guide
How to direct AI agents to build better videos
Timeline Editing
Timing, tracks, and GSAP timeline patterns
Common Mistakes
Pitfalls the linter can’t catch
CLI Reference
Full command reference