Hyperframes Cli
Published by heygen-com in hyperframes
What this skill does
Guides an agent through creating and editing HyperFrames video projects, checking timelines and scenes, previewing, and rendering approved output. It produces a checked project and verified export while keeping rendering behind user approval. Best for Marketers and creators building browser-based videos with HyperFrames.
Add Hyperframes Cli to your agent
Review the source and files first. When you are ready, copy the prompt instruction or use the CLI command supported by your environment.
Install with a prompt
Paste this into a compatible coding agent:
add this skill "hyperframes-cli" from https://github.com/heygen-com/hyperframesInstall with the CLI
Run this command in a controlled environment after reviewing the repository:
npx skills add https://github.com/heygen-com/hyperframes --skill hyperframes-cliSkill instructions
Running the CLI: every npx hyperframes <command> here, the beacon included, means node <SKILLS>/hyperframes/scripts/plugin-cli.mjs <command> run in the project, where <SKILLS> holds this skill's folder (rules).
Usage beacon: run npx hyperframes events --skill=hyperframes-cli once as this skill starts. It sends the skill's name with the CLI's usual telemetry (account-linked when signed in) and honours the opt-out.
HyperFrames CLI
Run npx hyperframes <command> as above, never a project's own scripts or wrapper unless the person names that command. A job with no TTY pins the release with the launcher's --cli-version <exact-version>, taking the version from the person or from --cli-version latest --version, never from the project's files and never a floating install (references/unattended.md). It needs Node.js 22+ and FFmpeg. Every command has --help; most take --json, and a failure prints ✗ …, a Fix: line and exits non-zero.
A --json result may carry _meta.updateNotice: a newer HyperFrames release is out. Pass it to the person once per conversation, in your own words, at a natural pause; updating is theirs to decide.
Commands by job
| Job | Commands |
|---|---|
| Start | init <dir> --skip-skills (blank; --example <name> only when asked), capture <url> |
| Read a project | info, compositions, timeline --json, docs <topic> |
| Check it | lint while writing; check --json as the gate (lint, runtime, layout, contrast) |
| Look at it | snapshot (--at <t,…>, --range START,END, --composition <id>, --zoom, --angle, --against <video>), keyframes, compare, audio |
| Edit the timeline | timeline with move, trim, split, set, duplicate, delete, apply, undo, ids |
| Reuse | catalog, add (/hyperframes-registry) |
| Media and sound | media-treatment, grade-compare, remove-background, tts, transcribe, beats, normalize-audio (/media-use) |
| Show and ship | preview, present (/slideshow), render, share, publish (legacy), cloud, lambda, cloudrun |
| Desktop app | open, catch-up |
| Upkeep | doctor, browser, upgrade, usage, clean, feedback |
captions is not a command: run transcribe, then read ../hyperframes/references/captions.md.
validate, inspect and layout are deprecated aliases of check; events is skills' own telemetry. Don't run them.
The loop
- Write, then
npx hyperframes lintafter the first pass and after structural changes. npx hyperframes check --jsonand fix every error. While a lint error remains the layout and contrast audits don't run; "0 samples" means nothing was checked. Contrast failures carry asuggestedColor. A finding at a single sample (an entrance in flight) is info; a 3 s+ video with no visible change failssweep_static.npx hyperframes snapshotand read the PNGs (under.hyperframes/artifacts/snapshots/): that is how you see the video. With sub-compositions, snapshot a midpoint of every scene; tiny unstyled content or a missing hero is a mount defect (../hyperframes/references/format.md).npx hyperframes preview --background, check the URL answers 200, give the person the project URL and wait, unless they asked for the file or for no stops. Passing checks alone is not a reason to render.- Time to render (step 4):
npx hyperframes render --quality looks -o out.mp4(draftwhile iterating,deliveryfor the final; paid plan:cloud render --fps <data-fps> --quality high -o out.mp4). Confirm the file is non-empty andffprobereports the rootdata-durationand the project'sdata-width/data-height, then look at decoded frames.
"This element" or the current selection: npx hyperframes preview --context --json --context-fields selection; no-selection means ask them to click it.
Edit the timeline
These are the edits Studio itself makes, so the result stays in Studio's shape.
timeline --jsonlists clips with absoluteabsStart/absEnd, owningfileand the#idref the edit commands take (timeline idsstamps missing ids).timeline move|trim|split|set|duplicate|delete <ref> … --plan --jsonpreviews one edit; run it again without--plan.--start,--end,--durationset one edge or the length.- An edit is refused when the clip would overlap a neighbour (
--overwrite, or move the neighbour first) or end past its composition: raise the root'sdata-durationfirst. No command changesdata-duration. - Several edits at once: a JSON file such as
[{"verb": "move", "ref": "#outro", "time": "9"}], thentimeline apply plan.json --json. Each run prints areceipt; save it andtimeline undo receipt.jsonreverts it.
Project history
Every write is kept and can be undone. At the start of a turn, npx hyperframes history begin --who <you> --label "<plan>", then history --since mine --who <you> to see what the person changed; build on their edits. A check failed or they say it got worse: history undo --who <you>, never hand-edit back. End the turn with history end.
Render where
| Need | Command |
|---|---|
| Local | render --quality looks -o out.mp4 (draft, delivery) |
| Reproducible container | render --docker --strict -o out.mp4 |
| Batch from variables | render --batch rows.json -o "renders/{name}.mp4" |
| Hosted, no local Chrome or FFmpeg | cloud render (references/cloud.md) |
| Your own AWS or GCP | lambda render, cloudrun render (references/lambda.md, references/cloudrun.md) |
A 30 s film renders in a minute or two: run it in the foreground. Detach only a render longer than your tool's timeout (HYPERFRAMES_RENDER_DETACHED=1, its own group, output to a log) and wait with until grep -qE 'Render (complete|failed)' render.log; do sleep 5; done, never pgrep -f, which matches its own loop and waits until the tool times out.
After a verified render, send one feedback --rating, plus a report for anything the person asked for that HyperFrames can't do, unless telemetry is off: references/feedback.md.
When a command fails
| Symptom | Fix |
|---|---|
| Chrome missing or won't start | npx hyperframes browser ensure; doctor --json always exits 0, gate on .ok |
| A heavy page isn't ready in time | Raise --timeout on check or snapshot |
| Unusual codec looks blank | Keep --proxy on (the default) |
| Render slow on Linux | The summary's second line says screenshot + software gpu: the slow path |
capture fails or writes BLOCKED.md | Take nothing from its partial files; retry into a new -o folder |
| Disk tight | clean --dry-run, then clean; never delete .hyperframes (it holds history) |
References
Read the row before running its command.
| Commands | Read |
|---|---|
init, capture, skills | references/init-and-scaffold.md |
lint, check, motion sidecars, snapshot | references/lint-validate-inspect.md |
compare, grade-compare, render --batch | references/compare-and-batch.md |
beats | references/beats.md |
preview, play, render, share, publish (legacy), Studio context | references/preview-render.md |
doctor, browser | references/doctor-browser.md |
auth, cloud, template variables | references/cloud.md |
lambda, cloudrun | references/lambda.md, references/cloudrun.md |
info, upgrade, compositions, timeline, docs, usage, telemetry | references/upgrade-info-misc.md |
--strict flags, run ids, clean, shader lint, JSON paths | references/conventions.md |
keyframes | ../hyperframes/references/motion.md (Seeing motion) |
Files included
- SKILL.md
- references/beats.md
- references/cloudrun.md
- references/cloud.md
- references/feedback.md
- references/conventions.md
- references/compare-and-batch.md
- references/unattended.md
- references/init-and-scaffold.md
- references/doctor-browser.md
- references/lambda.md
- references/upgrade-info-misc.md
- references/lint-validate-inspect.md
- references/preview-render.md

