Files
Vance Ingalls db5f149c53 fix(cli): carry worker sizing and sampled peak memory on render_error
PRINFRA-341 asks whether renders that exceed the heap advisory go on to OOM.
That question is unanswerable against the current fleet: `workers_bound_by`,
`workers_heap_based`, `workers_heap_limit_mb` and `workers_exceed_heap_advisory`
are emitted on `render_complete` only, so 0 of 317,253 `render_error` events
over the last seven weeks carry any of them.

The cause is lifecycle, not intent: those props are read off `job.perfSummary`,
which is assembled after a render succeeds. A render that dies mid-capture
never reaches that assignment.

Record sizing and sampled peak memory onto the job from the memory-sampler
disposer instead, which the execution context runs on every exit including a
throw, and read them on the failure path. Also prefer the sampler's running
peak over the teardown RSS snapshot on both paths: `peak_memory_mb` previously
reported whatever RSS happened to be at teardown, missing the mid-render spike
the field exists to catch. Adds `peak_heap_used_mb` alongside it.

Limitation, stated because it bounds what this buys: a fatal V8
`FATAL ERROR: Reached heap limit` aborts the process before any event is sent,
so heap OOMs remain invisible to telemetry. This narrows the gap to failures
that reach an error handler; it does not close it.

Extracted `recordJobFailureMetrics` and `failureSizingTelemetry` so the copy is
unit-testable rather than buried in a closure, and so handleRenderError's
branch count does not grow. Tests cover the summary-to-event hop on the error
path, peaks recorded when sizing was never computed, and an existing sizing not
being blanked; all verified by mutation.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-09-11 00:22:28 -07:00
..
2026-09-10 14:45:17 -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: 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

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