hyperframes-cli
Installation
Summary
CLI toolkit for scaffolding, validating, previewing, and rendering HyperFrames video compositions.
- Scaffolds projects with
init(9 templates available), lints compositions for structural errors, and visually inspects layouts for text overflow and clipping issues across the timeline - Preview mode hot-reloads on file changes; render supports quality tiers (draft/standard/high), multiple formats (MP4/WebM), frame rates, and parametrized variable overrides
- Includes environment troubleshooting commands (
doctor,browser,info) and requires Node.js >= 22 and FFmpeg - For audio preprocessing (TTS, transcription, background removal), use the
hyperframes-mediaskill instead
SKILL.md
HyperFrames CLI
Run commands as npx hyperframes ... unless project instructions provide a wrapper. Obey the wrapper when present. The CLI requires Node.js 22 or newer and FFmpeg.
Development loop
- Scaffold:
npx hyperframes init <project>(centered blank). Or capture a site. Pass--example=<name>only to start from a named example. - Find the move: before authoring motion by hand, search for a primitive that already does it:
npx hyperframes catalog --query "reveal a headline one line at a time". Ask for the effect you want rather than the mechanism you have in mind. Install withnpx hyperframes add <name>(see/hyperframes-registry). Author by hand only once nothing fits. - Author: write the composition using
/hyperframes-core. - Get fast feedback while editing: run
npx hyperframes lintafter the first HTML pass and after structural changes. - Run the final gate: run
npx hyperframes check; it reruns lint before opening the browser. Do not prepend a redundant standalone lint invocation. Add--snapshotsfor annotated overview frames and finding crops. - Inspect sub-compositions: when
index.htmlmountsdata-composition-src, capture midpoint snapshots and inspect each mounted scene. - Open the final Studio preview: run
npx hyperframes preview --background, verify the URL returns HTTP 200, hand the timeline project URL to the user, and ask whether to revise or render. Keep it alive until review ends. - Render only after approval: use
--quality draftwhile iterating,--quality looksfor the first real encode (the CLI default), and--quality deliveryfor final delivery. - Verify the output: confirm the file exists and is non-empty. Read the render summary's second line (
beginframevsscreenshot, GPU, stage timings).screenshot+software gpuon Linux is the slow path.ffprobe -v error -show_format -show_streamsand compare duration (and fps if the brief set it) to the rootdata-duration.
Mandatory creator-edit cross-references
Installs
558.3K
Repository
heygen-com/hyperframesGitHub Stars
50.4K
First Seen
Mar 31, 2026
Security Audits