hyperframes-cli
GitHubHyperFrames CLI 开发循环工具，支持视频初始化、HTML 编排、代码检查、验证、预览及渲染。涵盖本地迭代、Docker 复现与 AWS Lambda 云渲染，提供 Agent 友好的 JSON 输出和环境诊断功能。
Trigger Scenarios
Install
npx skills add fanfan-de/anybox --skill hyperframes-cli -g -y
SKILL.md
Frontmatter
{
"name": "hyperframes-cli",
"description": "HyperFrames CLI dev loop. Use when running npx hyperframes init, add, catalog, capture, lint, validate, inspect, layout, snapshot, preview, play, render, publish, lambda, doctor, browser, info, upgrade, skills, compositions, docs, benchmark, telemetry, transcribe, tts, or remove-background, or when troubleshooting the HyperFrames build\/render environment. Entry point for AWS Lambda cloud rendering (`hyperframes lambda deploy \/ render \/ progress \/ destroy \/ policies`)."
}
HyperFrames CLI
Everything runs through npx hyperframes unless project instructions specify a local wrapper. Obey the local wrapper exactly. Requires Node.js >= 22 and FFmpeg.
Workflow
- Scaffold —
npx hyperframes init my-video(orcapturefrom a URL) - Write — author HTML composition (see the
hyperframes-coreskill) - Lint —
npx hyperframes lint - Validate —
npx hyperframes validate(runtime errors + contrast) - Visual inspect —
npx hyperframes inspect - Preview —
npx hyperframes preview - Render — pick the variant:
- Iterate:
npx hyperframes render --quality draft - Deliver:
npx hyperframes render --quality high --output out.mp4 - CI / cross-host repro:
npx hyperframes render --docker --strict --output out.mp4 - Cloud (long / large):
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait(see Lambda below)
- Iterate:
Run lint, validate, and inspect before preview. lint catches missing data-composition-id, overlapping tracks, and unregistered timelines. validate loads the composition in headless Chrome and reports runtime console errors plus WCAG contrast issues. inspect seeks through the timeline and reports text spilling out of bubbles/containers or off the canvas — and, when a *.motion.json sidecar is present, verifies motion intent (entrances firing under seek, stagger order, in-frame, liveness) against that same seeked timeline.
For motion-heavy work, prefer snapshot-driven iteration and a *.motion.json sidecar — see references/lint-validate-inspect.md for the discipline and motion-verification spec.
Agent Conventions
Cross-cutting rules that hold for every command:
--jsonis available on every command exceptrender,preview, andplay. Use it for any agent / CI invocation of the supported commands; output includes a_metaenvelope (cli version, latest available, update advice).renderreports status via stdout + exit code only — verify success with the post-render check below;preview/playare servers, no JSON.doctor --jsonalways exits 0, even when the environment is broken. Gate on the payload'sokfield:npx hyperframes doctor --json | jq -e '.ok' > /dev/null. This insulates pipelines from CLI release churn.- Non-TTY mode is auto-detected. When
stdoutis not a TTY (CI, agents, piped output) the CLI auto-switches to non-interactive;initthen requires--example. Pass--non-interactiveto force this mode even on a TTY. - CI gating on render:
--strictfails on lint errors,--strict-allfails on warnings too,--strict-variablesfails on undeclared--variableskeys. - Paths in
--jsonare redacted —$HOMEbecomes the literal$HOMEso output is safe to paste into bug reports and agent contexts. - Post-render verification. After
renderreturns exit 0, confirm the output file exists and has plausible size before reporting success:[ -s "$OUTPUT" ] || echo "render produced no output". The CLI prints◇ <path>on success; for long renders also sanity-check duration withffprobe -i "$OUTPUT" -show_format -v error.
Routing
| Want to… | Read |
|---|---|
Scaffold a project (init, capture, skills) |
references/init-and-scaffold.md |
Check correctness (lint, validate, inspect, snapshot) |
references/lint-validate-inspect.md |
Preview or render (preview, play, render, publish) |
references/preview-render.md |
Diagnose the environment (doctor, browser) |
references/doctor-browser.md |
Cloud render on AWS Lambda (lambda deploy / sites / render / progress / destroy / policies) |
references/lambda.md |
Everything else (info, upgrade, compositions, docs, benchmark, telemetry, asset preprocessing) |
references/upgrade-info-misc.md |
Cross-Skill Hand-Offs
- Tailwind projects (
init --tailwind) → usehyperframes-core(Tailwind reference) before editing classes or theme tokens. - Registry blocks/components (
hyperframes add,hyperframes catalog) → usehyperframes-registryfor install paths, sub-composition wiring, and snippet merging. - Asset preprocessing (
tts,transcribe,remove-background) → usehyperframes-mediafor voice selection, Whisper model rules, captions, and TTS-to-captions chain. - Parametrized renders (
--variables) → declared viadata-composition-variableson<html>; seehyperframes-corefor the full schema.
Lambda (Cloud Rendering)
hyperframes lambda deploys distributed rendering to AWS Lambda and drives renders from your laptop or CI. End-to-end is three commands:
npx hyperframes lambda deploy # provision SAM stack (Lambda + Step Functions + S3)
npx hyperframes lambda render ./my-project --width 1920 --height 1080 --wait
npx hyperframes lambda destroy # tear down (S3 bucket is retained)
Use Lambda when a render is too long / too large for one host (multi-minute videos, 4K, large parallel batches) and you have AWS credentials configured. For dev-loop iteration stay on local render.
See references/lambda.md for prerequisites, all 6 subcommands (deploy, sites create, render, progress, destroy, policies), IAM policy validation, state files, and cost / cleanup rules.
Minimum Completion Gate
Static gates
npx hyperframes lint
npx hyperframes validate
Add inspect for layout-sensitive work and render --strict in CI to fail on lint errors.
Visual smoke test — required when the project uses sub-compositions
lint / validate / inspect evaluate each composition in isolation. They never load index.html and mount sub-compositions via data-composition-src, so they cannot catch cross-file mount failures (see hyperframes-core → references/sub-compositions.md, "Common pitfalls"). The only gate that catches them is one that actually loads index.html and seeks the timeline.
Use hyperframes snapshot — it loads the project the same way render does (so it exercises the same mount path) but only captures the timestamps you request, so it's seconds instead of a full render:
# Capture one frame at the midpoint of every sub-composition.
# Midpoints = data-start + data-duration/2 for each host slot in index.html.
npx hyperframes snapshot --at <t1>,<t2>,<t3>,...
# Or, if you don't need per-scene targeting, an evenly-spaced sample:
npx hyperframes snapshot --frames 9
Output lands in snapshots/frame-NN-at-Xs.png. Eyeball each frame against the scene plan.
Per-frame red flags (each maps to a specific failure mode the static gates miss):
| What you see | Root cause |
|---|---|
| Text shows up tiny + unstyled in the top-left corner | <style> block left in <head> outside <template> (Pitfall 1) — no CSS reached live DOM |
| SVG/icon elements blown up to canvas-size | Same as above — no width/height constraints applied |
| Hero element of the scene is missing entirely; only background + watermark visible | Host-id ≠ template id (Pitfall 2) — timeline never ran, frame captured at initial state |
Snapshot command logs Sub-composition timelines not registered after 45000ms |
Pitfall 2 — direct confirmation |
snapshots/ can be deleted after eyeballing; the user-facing final render is a separate pass with npx hyperframes render.
Version History
- 08dc189 Current 2026-07-05 19:02
