Files
hyperframes/packages/cli
Michael WangandClaude Opus 5.5 a243169f8a fix: keep private project files out of preview bundles and local sharing (#7563)
* fix(core): keep git metadata and env files out of bundled HTML

The bundler now checks every file it reads against the project's private
paths (git metadata and env files, spelled directly or through a link)
and leaves a refused reference as authored instead of inlining it.
Bundle options gain a canRead predicate; Studio's preview passes its own
private-file rule so the preview document matches what the file routes
serve.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(studio-server): check capture read grants against the decoded path

A capture page's read grant now looks at the path the way the static
preview route decodes it, including encoded separators, so a URL that
resolves to a dotfile or into a dot-folder gets no CORS grant. Ordinary
project files keep loading in thumbnails.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(cli): accept local share requests only from loopback connections

The local share routes already require loopback Host and same-origin
headers. They now also require the connection itself to come from this
machine, so a Studio bound to a network address still keeps sharing
local to the person running it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(studio-server): ask the bundler for Studio's private-file rule as plain data

The preview route passed a fresh `canRead` callback on every build. A host that builds on a
worker thread cannot send a function across, so it built on its own thread, and it could no
longer share one build between two same-content requests.

The bundler now takes `privateFiles: "studio"`, a plain string, and applies Studio's
private-file rule itself. That rule (git metadata, env files, and the app's records under
`.hyperframes/`) now lives in `@hyperframes/core/safe-path`, and studio-server reuses it.
The `canRead` option is removed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(studio-server): do not serve a preview main file linked to a private file

When index.html (or <id>.html) is a link to an env file or into git metadata, the
bundler refuses it and the route falls back to reading the main file from disk. That
fallback now skips a candidate that is a private project file, by the same rule the
file routes use. A main file linked from outside the project is still served.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(producer): never inline git or env files as render sub-compositions

The render compiler resolved data-composition-src and inlined the file it named, so
`data-composition-src=".env"` put the env file's text into the render page. It now
refuses git metadata and env files with the same shared rule the bundler uses. The
pre-render check names the refused reference and stops the render.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* chore: raise the inspector unpacked size budget to 3,722,000 bytes

The inspector already sat about 36.8 KB over its 3,684,092 budget, just inside the 1%
tolerance. Moving Studio's private-file rule into core added a few hundred bytes to the
bundles it ships, which pushed it to 3,721,419 bytes and over the tolerance.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-11 19:31:24 +00:00
..
2026-11-11 16:46:12 +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