Adds `render --require-version X.Y.Z`: refuse to render unless the running renderer is exactly that version. ## Why a pin is not enough `npx hyperframes@X.Y.Z` stops the renderer drifting between runs, but nothing checks the claim afterwards. A project states the version it believes it used and no artifact can contradict it. The provenance tag does not close the gap either. `hyperframes_version` stamped a constant `0.0.0-dev` for twenty published versions (#4365) — measured across 710 tagged mp4s, 710 carry that value, so the tag identifies nothing. #4409 fixes the stamp, which makes drift VISIBLE once a fixed build ships. This makes it ENFORCEABLE at the point it matters, before the encode. ## Three properties 1. **Fails closed on an unresolved version.** If the engine cannot say what it is, the gate cannot verify anything, and passing would hand back exactly the unfalsifiable claim the flag exists to remove — while looking green. It compares against the engine's exported `UNRESOLVED_VERSION` rather than a re-typed literal. 2. **Exact, never a range.** npm already gives the caller ranges. This answers "did the version I named run", and a caret would let the gate pass on a version the caller never named. 3. **Runs before the plan**, so a mismatch costs a startup rather than a full encode. ## Verification `checkRequiredVersion` is a pure function so the guard can be exercised; a guard that cannot be reached is one nobody has checked. 9 tests, extracted and executed: exact match, whitespace, mismatch naming both versions, fail-closed on unresolved, three exactness cases, empty value, and that the sentinel cannot be satisfied by asking for it by name. Two mutations, both red attributably: - drop the fail-closed branch -> exactly the 2 unresolved tests fail - lenient `startsWith` match -> exactly the 2 exactness tests fail The second is the one worth having: a prefix match is the tempting lenient implementation, and it silently passes `--require-version 0.8.7` against a running 0.8.72. I could not run the vitest suite here (no bun/node_modules on this machine), so please let CI confirm the suite itself rather than reading my green as a test run. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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: http://localhost:3002/#project/my-video
# Server: http://localhost:3002
npx hyperframes preview --port 4567
In an interactive terminal, the preview stays attached until you press
Ctrl+C. In a non-interactive shell such as a coding-agent session, the same
command starts a managed preview that survives after the command returns. Use
--background or --foreground to choose explicitly, and manage persistent
previews with --status, --stop, --list, and --kill-all. Add --json to
managed lifecycle commands for machine-readable output. --foreground --json
prints the ready-session envelope once, then remains attached until stopped.
normalize-audio
Measure two local authored audio clips with integrated LUFS and match the target
to the unchanged reference. The command is a dry run unless --write is passed:
npx hyperframes normalize-audio --reference target-audio --target user-audio
npx hyperframes normalize-audio --reference target-audio --target user-audio --write
It updates only the target element's data-volume and refuses unsafe boosts
that exceed Studio's +12 dB ceiling or would clip.
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
Set HYPERFRAMES_RENDER_DETACHED=1 when starting a render with nohup or
disown so it keeps running after the invoking shell exits.
publish
Upload a project directory and get a hosted URL that keeps working after the CLI exits. Published projects are private by default:
npx hyperframes publish
npx hyperframes publish ./my-video
npx hyperframes publish --public
npx hyperframes publish --yes
Signed-out publishing returns an authentication-required claim URL; opening it
lets someone sign in and claim the project. Sign in first with
npx hyperframes auth login to publish an owned project you can update. Use
--public to make the claimed project visible to anyone. --yes only skips the
confirmation prompt and does not change visibility.
Signed-in publishers can use --update <url-or-id> to target an existing project
or --space <space-id> to publish into a shared team space. If the requested
project is missing or inaccessible, publishing can create a new project instead;
check the printed URL and status.
See the publish reference for all options, including video proxy settings.
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