Files
hyperframes/packages/cli
Miguel Angel Simon Sierra 74ae5d6e81 fix(review): harden transparent-proxy feature from code review
Review fixes across the proxy stack: proxyTranscoder committed as UTF-8
text (literal NUL delimiters became escapes; the file was binary to
git), ffmpeg children get a hard timeout so a hang can never wedge the
global transcode slots, failed transcodes are negative-cached so
pre-warm stops respawning doomed encodes, and client aborts after a
held response no longer write to a dead socket. Alpha sources (ProRes
4444 etc.) are never proxied anywhere, preview/Studio now honor
media.autoProxy and --no-proxy, the runtime swaps only when a codec map
is present (opt-out surfaces stay inert) and skips browser-safe
entries, the unavailable diagnostic is visible to check and devtools,
play serves proxies as video/mp4 with mov/m4v/mkv recognized, the
publish bake resolves srcs exactly like the scan (percent-encoded srcs
now rewritten), codec probing is genuinely async off the event loop,
and codec-map injection is one shared implementation across surfaces.
2026-07-14 22:25:47 -04: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. Run from the project directory; the positional argument is the project directory (not a file), so render the project's index.html directly, or point at a specific composition file with -c:

npx hyperframes render -o output.mp4
npx hyperframes render -c ./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