Miguel Angel Simon Sierra
bf26b3dd84
- Update cli, producer, studio, sdk to import from @hyperframes/parsers, @hyperframes/lint, @hyperframes/studio-server - Add new packages to noExternal in cli tsup config for binary bundling - Fix lintProject.test.ts: pass string dir instead of ProjectDir object after lintProject signature change to (projectDir: string) - Add @hyperframes/core/generators subpath to bypass esbuild barrel import in parsers tests (htmlParser.roundtrip + stableIds import test-utils which reached core barrel → hyperframesRuntime.engine → esbuild, breaking TextEncoder invariant in jsdom) - Remove circular lint re-export from core barrel; lint types now live only in @hyperframes/lint (core barrel was core→lint→core cycle) - Exclude runtime binary blobs from @hyperframes/core npm files tarball - Extend health.ignore for lint/project.ts, lint/rules/gsap.ts and files touched only for import-path updates (line-shift fingerprint problem)
hyperframes
CLI for creating, previewing, and rendering HTML video compositions.
Install
npm install -g hyperframes
Or use directly with npx:
npx hyperframes <command>
Requirements: Node.js >= 22, FFmpeg
Commands
init
Scaffold a new Hyperframes project from a template:
npx hyperframes init my-video
cd my-video
preview
Start the live preview studio in your browser:
npx hyperframes preview
# Studio running at http://localhost:3002
npx hyperframes preview --port 4567
render
Render a composition to MP4:
npx hyperframes render ./my-composition.html -o output.mp4
lint
Validate your Hyperframes HTML:
npx hyperframes lint ./my-composition
npx hyperframes lint ./my-composition --json # JSON output for CI/tooling
npx hyperframes lint ./my-composition --verbose # Include info-level findings
By default only errors and warnings are shown. Use --verbose to also display informational findings (e.g., external script dependency notices). Use --json for machine-readable output with errorCount, warningCount, infoCount, and a findings array.
compositions
List compositions found in the current project:
npx hyperframes compositions
benchmark
Run rendering benchmarks:
npx hyperframes benchmark ./my-composition.html
doctor
Check your environment for required dependencies (Chrome, FFmpeg, Node.js):
npx hyperframes doctor
browser
Manage the bundled Chrome/Chromium installation:
npx hyperframes browser
info
Print version and environment info:
npx hyperframes info
docs
Open the documentation in your browser:
npx hyperframes docs
upgrade
Check for updates and show upgrade instructions:
npx hyperframes upgrade
npx hyperframes upgrade --check --json # machine-readable for agents
Documentation
Full documentation: hyperframes.heygen.com/packages/cli
Related packages
@hyperframes/core— types, parsers, frame adapters@hyperframes/engine— rendering engine@hyperframes/producer— render pipeline@hyperframes/studio— composition editor UI