* fix(engine): the media playlist check reads HLS lines and attributes as ffmpeg does The folder check now finds every name ffmpeg's hls demuxer would open: - lines end at CR, LF or NUL, and a line is also read cut at ffmpeg's 4095-byte limit; - URI attributes are split like ff_parse_key_value: quoted or bare values, with backslash escapes removed; - leading ID3v2 tags are skipped before the playlist signature, and a file behind more than 16 of them is refused. Each refused shape is checked against ffprobe 8 in the test: ffprobe opens the outside file, and playlistLeavesItsFolder now refuses the list. * fix(cli): snapshot never hands FFmpeg a project video that is a document or an escaping playlist `hyperframes snapshot` decodes held project videos with FFmpeg and FFprobe. It now runs the engine's media check first: a file that is a document, or an HLS or ffconcat list naming files outside its folder (under any extension), is skipped with a "not media" warning and never reaches FFprobe or FFmpeg. Real clips and HLS lists of segments beside them snapshot as before. * fix(engine): playlist check reads lines as bytes and refuses unreadable nested lists - Playlist text is read as latin1, one character per byte, so a line is cut at 4095 bytes exactly where ffmpeg cuts it, even when it holds bytes that are not UTF-8. Nested names are opened by those same bytes. - A nested name that exists but cannot be read is refused; a name that does not exist, or is too long to exist, is still kept. - Each name is checked once, each file is opened once (ID3 header and head in one read), and each file's verdict is reused within a call: 100k segments naming one file drop from seconds to tens of milliseconds. * perf(cli): snapshot checks each project video once and warns once when it is refused * test(engine): the ffprobe playlist proof ends its options with -- before the input * chore(engine): raise the packed size budget to 500000 bytes The byte-exact HLS playlist parser adds about 6 KB to the packed engine (496647 in CI against a 490452 budget). * fix(engine): media inspection never waits on a FIFO or device The document sniff and the playlist walk open with O_RDONLY|O_NONBLOCK where the platform has it, fstat the descriptor, and refuse anything that is not a regular file before reading; a folder still fails as it did. A FIFO with no writer, as a media source or named in a list, is refused at once. * fix(cli): snapshot inspects project videos within the probe deadline and its cleanup scope The held-video hints are gathered inside the capture's cleanup scope, and every media inspection gives up after the same 30 s limit as the FFprobe call it guards, treating the file as not media.
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