Files
hyperframes/packages/cli
Michael Wang 3e788fb15a fix(cli): show control characters in printed names as visible escapes (#8008)
* fix(cli): project folder names print control characters as visible escapes

check, info, compositions, benchmark, play, present and preview printed the
project folder name, and in places the project path, straight to the
terminal. A folder name can hold escape bytes on Linux and macOS, so a
received project could move the cursor, rewrite earlier lines, set the
window title or write the clipboard. Those lines now go through
terminalText(), as validate, snapshot, layout and lint already do. This
covers the preview summary, --status, --stop, --list and --kill-all lines,
and the check report path. The CLI's own colours stay, and --json output is
unchanged.

The play page also HTML-escapes the name in its title and footer, as the
present page does.

* fix(cli): preview --selection and --context print Studio text as visible escapes

The human output of preview --selection and --context printed the selected
element's label, source file, target and thumbnail URL, and the preview
server's project name, straight to the terminal. These come from the
composition or from whichever preview server answers, so control characters
in them could move the cursor, rewrite earlier lines, set the window title
or write the clipboard. They now go through terminalText(), as do the
failure messages these commands print. The CLI's own colours stay, and
--json output is unchanged.

* fix(cli): cloud get, list and delete print server fields as visible escapes

The human output of cloud get printed render fields from the server, such
as the failure message, title, composition and URLs, straight to the
terminal. A failure message can quote text from the rendered project, so
control characters in it could move the cursor, rewrite earlier lines, set
the window title or write the clipboard. cloud get, cloud list (rows and
the next-page token) and cloud delete now pass those fields through
terminalText(). The CLI's own colours stay, and --json output is unchanged.

* fix(inspector): the live inspection stamp gives the page only the generation id

prepareLiveInspection wrote the project's absolute path into the preview
page as window.__hfLiveInspection.project. Nothing in the page reads it, but
any composition script on that page could, which told it the account name
and folder layout. The page now gets only the generation id; the project
path stays with the host that prepared the page.

* fix(skills): locate.mjs keeps its grid font in a private per-run folder

locate.mjs drew its grid labels with a font at the fixed shared path
/tmp/locate-font.ttf. It used whatever file was already there and copied a
system font onto that path otherwise, following any link in its place. On a
machine shared with other accounts, someone else could plant that file
first, so the grid showed wrong numbers, a file appeared where they chose,
or every run failed.

The font is now copied into a folder made with mkdtemp (mode 0700) for each
run and removed when the run ends, so no file another account can create is
read or written. The skills manifest hash is regenerated.

* fix: escape the check report path and lint warnings, and harden locate.mjs font cleanup

check's report path notice and its not-recorded warning, and preview's
"Lint did not finish" warning, now print control characters as visible
escapes, like the other lines that carry the project path.

locate.mjs escapes the font path for ffmpeg's filter syntax, so a temp
folder with ':', ',', quotes or brackets in its name still works, and it
removes its font folder when the run is stopped by SIGINT or SIGTERM before
re-raising the signal.

play and present share one HTML escape helper.

* refactor(cli): keep the shared HTML escape helper within the comment budget

* fix: one HTML escape helper for the CLI, and locate.mjs escapes its font path in one pass

The sign-in callback page uses the shared escapeHtml helper, which now also
escapes single quotes.

locate.mjs escapes the font path for ffmpeg's option list and filtergraph
in a single replacement with the same result as before, and removes its
font folder on SIGHUP as well as SIGINT and SIGTERM.

* fix(cli): escape render output paths and cloud upload names

A finished render printed its output path and the desktop app hint raw.
The default output path sits under the project folder and is named after
it, so the folder name reached the terminal on every render. Batch renders
printed row output paths and the manifest path raw, and cloud render
printed the archive name in its upload progress lines and walked file
names in its left-out warnings raw. These lines now go through
terminalText() or terminalLines(). --json output is unchanged.
2026-11-18 09:30:01 +00:00
..
2026-11-17 23:19:45 +00: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.

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