Files
hyperframes/packages/cli
Michael Wang 7623f4fa12 fix(cli): a received project's job log can't lower the credit limit, and publish names the project it updates (#7970)
* fix(cli): the credit limit counts no logged row below zero and resumes only keys this account sent

A job log row whose credits are negative or not finite now holds nothing,
so no row can lower the total spent against the limit. A logged job key
skips the limit check only when this account sent it before, as noted in
a per-account record in the config folder. A logged key it never sent is
priced as a new call, without the credits the log gives that key. Applied
to both copies of credit-limit.mjs.

* fix(cli): publish's prompt names the existing project it updates and says its visibility is kept

When the publish targets an existing project (an --update id, the folder's
.hyperframes/project.json, or this machine's earlier publish of the
folder), the confirmation now names that project and says it keeps its
current visibility, which may be public, instead of promising a private
upload. The id is shown as printable text only.

* docs(cli): credit-limit says a logged row never counts below zero

The earlier commit said no row can lower the total. That is not so: a
later row for the same key with credits 0 sets that key to zero, which is
how a refused call gives back its reservation and how a charge below the
estimate replaces it. What holds is that no row counts below zero.

* fix(cli): sent job keys are noted per account and project folder, privately and capped

A logged key now resumes unchecked only when this account sent it for the
same project folder, so a key sent for one project cannot skip the limit
in another. The record keeps its newest 10,000 keys, and the config
folder and key files are created readable by their owner only.

* fix(cli): publish's prompt names the existing project in every variant

Every prompt variant, --public included, now names the existing project a
publish would update. It says the update happens only when the person is
signed in and can access that project, and that otherwise a new project
is created, which is what a signed-out publish does.

* fix(cli): the credit limit reads this account's spending from its own ledger

Each account now keeps, in its config folder, a ledger of what its jobs in
each project folder hold: every charge, reservation and refund the CLI
logs is noted there too. The limit check counts this account's keys at
the ledger's value and ignores the project log's rows for them, so a row
a sync or a pull adds cannot lower them. Any other key in the project log
counts at the most it has been seen to hold, never less, and never lets a
call skip the check. This replaces the sent-key record; the ledger keeps
its newest 10,000 lines and is readable by its owner only.

* fix(cli): publish reads the sign-in before asking, so its prompt says what will happen

The credential is now read, and --update or --space without a login is
refused, before the confirmation prompt. The prompt names an existing
target project only for a login, which is the only case that updates it
in place; signed out or on an API key, the prompt describes the new
private upload that actually happens.

* fix(cli): creditsSpent skips a malformed or null job log line

One junk line in .hyperframes/heygen-jobs.jsonl no longer blocks every
priced call in the project; the reader skips it, as the account ledger
reader does. Applied to both copies of credit-limit.mjs.

* fix(cli): the credit limit refuses a paid call when it can't tell which account is signed in

Under a credit limit, a call whose signed-in account can't be named is
refused before anything is sent, since this account's ledger can't be
read or written then. With no limit set, nothing changes.

The ledger is trimmed through a temp file and a rename, and the project
being checked keeps its last line for every key it holds. A refusal that
counts credits from job log rows no longer in the project says so and
names the ledger file. The ledger scope notes that a moved or renamed
folder starts a new ledger. The private-mode check in the ledger test is
skipped on Windows, which has no POSIX modes.
2026-11-16 23:33:53 +00:00
..
2026-11-16 15:15:30 +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