Files
hyperframes/packages/cli
Michael Wang f5bb3e5519 fix: a received-files record follows Studio renames, moves and deletes, and a nested record can't be moved out of reach (#7989)
* fix(cli): a received folder's record is read wherever Studio moves it

The search for received-files records now walks every folder a render,
preview or publish can load files from, including renders/, dist/, .next/,
coverage/ and Studio's own folders in the project's .hyperframes/. A
received folder moved there by Studio keeps its files received.

Studio's folder delete and move also refuse a folder holding a
received-files record that lists a file outside its own folder, since
that file would stay behind with no record. A received folder whose
record lists only its own files can still be deleted or moved.

* fix(cli): a renamed or moved received file stays listed under its new name

The CLI-hosted Studio now follows every rename, move or delete it
completes in the received-files records, whichever client sent it. A
renamed file, or every file in a moved folder, stays listed under its
new path; a file moved out of a received folder is listed in the
project's own record. Changes are made under the record's lock, and a
record that cannot be changed is left as it was.

The per-file readers used by publish, cloud render, feedback and add now
count every file as received when a record lists a file that is no
longer on disk, since that file may be there under another name. This
matches the local render check. Projects with no record are unaffected.

* fix(cli): received content that leaves the record still counts as received

When a Studio rename, move or delete takes a received file off a listed
path, the sha256 of its content is kept in .hyperframes/received-content.json,
the file and format the desktop app uses; other keys in it are kept. A
file holding the same bytes counts as received for publish, cloud render,
feedback, add and the local render check, so content brought back by undo
or renamed outside Studio stays received. Studio's own backups do not count.

A listed file that is gone from disk now makes only pages, stylesheets,
scripts, SVG and links out of the project count as received, and the
upload warning names the gone file.

The record follows a request spelled in another letter case or Unicode
form by matching the name the disk holds, and waits for the record's lock
without blocking the server. Studio's folder delete and move no longer
refuse a folder whose record lists a file outside it; that file's content
is kept as received instead.

* fix(cli): a folder delete or move keeps what a record inside it lists elsewhere

Before Studio deletes or moves a folder, every file that a received-files
record inside the folder lists outside it is listed in the project's own
record by its path from the project folder. Such a file stays received
after it is edited, and a listed link stays received too. When the
project's record cannot be written, the delete or move is refused.

Received content that cannot be read is never written over, so the
desktop app's keys in it are kept. The warning about a listed file that is
gone now says how to clear it.

* fix(cli): received-content checks skip large non-code files and name a skipped search

A file larger than 16 MB that is not a page, stylesheet, script or SVG is
no longer read to compare its content with received content, so a large
archive is not read on every check. When the project has too many folders
to search for received-files records, the upload warning now says so.

The case-matching publish test now expects the gone-file rule on a disk
that tells letter case apart, and a comment no longer names a file path.

* fix(cli): name a gone received file from the project folder on every system

The gone-file note now names the file from the same project path the
record search starts at. On Windows, a short (8.3) folder name in the
temp path made the two spellings differ, so the note showed a long
relative path instead of the file's name.

Content hashing opens a file once, checks it through that handle and
reads from the same handle, and the received-content file is read before
it is classified, so nothing is checked by path and then used by path.

* fix(cli): received files stay received through undo, saves, and partial folder deletes

An undo, redo or restore lists again every file it writes that holds received
content, and a Studio save lists such a file before it changes it. So a Studio
delete followed by an undo and an edit leaves the file received.

A Studio rename, move or delete now records the received side first, under the
record's lock, and is refused when that fails: the content leaving listed paths
is kept, a renamed file is listed under its new path, and every line of a
record inside a moved or deleted folder is copied into the project's record.
Once the files have moved, only lines whose file was there and whose content
was kept are taken off. Lines at a rename's destination and lines whose file was
already gone stay. The search for records inside the folder has no size limit,
and nothing is locked when nothing is listed.

* fix(cli): unreadable received content counts every file as received

The readers treat a received-content file they cannot read the way they treat
an unreadable received-files record: every file counts as received, and the
local render check names the file it could not read.

A record line that points outside the project is ignored, so a record in a
received folder cannot make the readers look at or report files outside the
project.

* fix(cli): the CLI's own history undo and restore keep received files listed

`hyperframes history undo` and `restore` with no Studio running now list again
every file they write that holds received content, the same way Studio's
history routes do. A delete in Studio, then an undo or restore from the CLI,
then an edit, leaves the file received.

A Studio edit that names its file in the request body, such as a freeze-frame
edit, now lists that file first when it holds received content.
2026-11-17 05:12:31 +00:00
..
2026-11-17 01:59:35 +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