* fix(studio): dev Studio renders apply the received-project rule for outside files The Vite Studio adapter started every render with files from outside the project allowed. It now asks the CLI's outsideAssetsAllowed, the same check the CLI's embedded Studio, hyperframes render and benchmark use. A project whose received-files record lists code files, or cannot be read, renders without files from outside the project, and the reason prints with a [studio] prefix. The adapter loads the rule from the CLI source through the dev server, as it already does for background removal. It runs only from a source checkout, so studio takes no package dependency on the CLI. * fix(cli): a received project's .env provider key never replaces your own credential A received project's .env could set OPENROUTER_API_KEY, GEMINI_API_KEY, GOOGLE_API_KEY or Vertex settings that outranked a vision or Gemini credential the person set in the shell, so capture, snapshot describe and media-use speech and music could send content to another account. After the CLI and capture load a project .env, each provider key it set is unset when that .env came with a received project (a received-files record lists it, or a record cannot be read) and the person has their own credential for a competing provider. One stderr line names the key, the .env file and the credential used instead. A person's own project .env keeps its keys and its current precedence, so an OPENROUTER_API_KEY in a project .env still wins over a Gemini key in the shell, as the docs describe. Voice needs no change: the person's HeyGen credential already ranks above ElevenLabs. * fix(cli,media-use): media-use scripts apply the received .env rule, ElevenLabs included The media-use audio scripts read the project .env again, so a Gemini key the CLI had left out came back. They now apply the same rule after loading: a key from a received project's .env gives way to the person's own credential for a competing provider. GEMINI_API_KEY and GOOGLE_API_KEY give way to the person's Gemini key or service account. ELEVENLABS_API_KEY gives way to the person's HeyGen sign-in, saved key or shell key. A dropped key gets one stderr line that names the file and the credential used instead. A received ElevenLabs key that is still used, because the person has no competing credential, gets one stderr line naming the .env before speech starts. hyperframes media-use tells the engine which keys it took from a project .env (HYPERFRAMES_PROJECT_ENV_ORIGINS), so a key the CLI loaded is not mistaken for the shell's. When the project's folders are too many to scan for received-files records, the CLI's note now says the project's origin could not be checked, instead of calling it a received project. * refactor(studio): check the shape of the CLI's outside-files rule before calling it The Vite adapter loads outsideAssetsAllowed from the CLI source at run time. It now checks that the export is a function and treats only a true result as allowed, instead of casting the module's export. * docs(auth): a received project's ElevenLabs key gives way to your HeyGen credential * test(studio): load the received-project rule before render waits start
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.
audio
Measure where sounds land: onsets, the moment each sound peaks, loudness and silence. Give files, or query the film's own clips in film time:
npx hyperframes audio sfx/whoosh.mp3
npx hyperframes audio --at 12 --json
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. Where a full match would pass
Studio's +12 dB ceiling or -1.5 dBTP, it applies the most that fits and says how far
under the reference that leaves the target.
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
A render stops when the process that started it exits. To keep one running after
its launcher exits, set HYPERFRAMES_RENDER_DETACHED=1 and start it in its own
process group, e.g. bash -c 'set -m; HYPERFRAMES_RENDER_DETACHED=1 npx hyperframes render -o out.mp4 < /dev/null > render.log 2>&1 &'.
Piped, non-quiet renders emit a single @hf-diagnostic JSON line when an audio
failure reaches the CLI error handler. Version 1 has operation: "render" and
at most 16 audioFailures: allowlisted stage, reason, owner, retryable, and
optional subprocess exit code, signal, termination reason and OS code. It omits
messages, stderr, source paths/URLs, element IDs and command arguments. Consumers
must ignore unknown versions and fields. This is local CLI output; uploading it
requires the caller's existing consent and privacy checks. Quiet mode (including
batch JSON mode) emits no diagnostic line.
This covers audio preparation and mix failures, including the typed external interruption path. Probe failures retain their existing stage/reason but do not gain subprocess evidence here; browser/FX failures remain classified as internal. Desktop ingestion and live report delivery are separate changes.
Piped, non-quiet renders also emit a single @hf-result JSON line after a local
render succeeds, never after a failure. Version 1 has operation: "render" and
reference_background, the background the render measured from the composition's
root and body: {"kind":"solid","rgb":[r,g,b]}, {"kind":"none"},
{"kind":"unsupported_non_solid"} or {"kind":"unknown"}. A render that applied
motion blur also carries motion_blur: tier ("capture" or "filter", absent
when none ran), movers, failed_frames and a fingerprint of 14 snake_case
counts (absent when the page produced none); it is absent when the render has no
blur summary. Consumers must ignore unknown versions and fields. A --docker render prints no result line from the
launcher. In batch mode each manifest row carries the same reference_background value (null until the row completes, and for a
row that failed).
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
update
Check the CLI and the installed skills for updates in one call, or install both:
npx hyperframes update --check --json # report only, machine-readable for agents
npx hyperframes update --yes # upgrade the CLI, then refresh the skills
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