Files
Miguel Ángel 8f9ee9f55d test(studio): add preview/render parity E2E gate
Playwright test that drives the real Studio UI — selects elements via the
Layers panel, modifies X position, text color, and opacity — then screenshots
the preview at t=0/1/2s, triggers a real render, extracts matching frames with
ffmpeg, and fails if the average luma diff exceeds 0.78% of 255 (YAVG > 2.0).

Also adds the GitHub Actions workflow that runs on any change touching studio,
core, player, producer, engine, or cli, with diff artifact upload on failure.

Supporting changes:
- StudioApiAdapter.onProjectFileWrite optional callback so file writes from the
  files API can notify the server to invalidate its cached ETag signature
- CLI adapter implements onProjectFileWrite by nulling cachedProjectSignature,
  ensuring the preview ETag advances after every UI edit
- Playwright config, fixture project (index.html + generated assets), and
  asset generator script (e2e/setup/gen-assets.ts via ffmpeg)
2026-05-13 13:45:05 -07:00
..
2026-05-13 13:40:37 -07:00

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