Files
hyperframes/packages/cli
Michael WangandClaude Opus 5.5 a07d4cf738 fix(cli): printed Windows commands read folder names literally in every shell (#7769)
* fix(cli): printed Windows commands read folder names literally in PowerShell, cmd and Git Bash

shellArg's Windows branch wrapped any non-plain name in double quotes,
where PowerShell and Git Bash still expand $ and backticks. Names with
those characters (or PowerShell's curly quotes) are now single-quoted,
which both shells read literally; a name that cmd.exe would also split
on & | < > ^ gets no printed path, and the hint says to run the command
from the project folder. A bare comma or leading @ is quoted so
PowerShell does not read an array or a splat. Ordinary names with
spaces, accents and apostrophes print as before.

The background preview's stop footer uses the same helper instead of
JSON quoting, which left $(...) live in POSIX shells and PowerShell.

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

* fix(cli): printed Windows paths with backslashes keep them in Git Bash

A Windows word containing a backslash printed bare, and Git Bash strips
unquoted backslashes, so C:\Users\Bob\film reached the CLI as
C:UsersBobfilm. Such words now take double quotes, which PowerShell,
cmd.exe and Git Bash all read as written; trailing backslashes are
doubled so they do not escape the closing quote.

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

* fix(cli): open --json gives a null stopCommand when the folder has no safe spelling

When no spelling of the project folder is safe to paste in every Windows
shell, the left-running preview's stopCommand held prose. It is now null,
and stopCommandFromProject names the command to run from inside the
project folder. The printed line is unchanged.

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

* chore(cli): drop a comment the nullable return type already states

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

* fix(cli): a Windows name with no spelling common to every shell prints no path

PowerShell single quotes do not group a word in cmd.exe, and Git Bash
reads 'it''s' as its, so the single-quoted form printed for names with
$, a backtick or a curly double quote was wrong in two of the three
shells. Those names now take the existing null fallback, and the hint
says to run the command from the project folder.

Round-trip tests check that every printed Windows word reaches the
program unchanged: through Git Bash everywhere, and through cmd.exe and
PowerShell on Windows, where the CLI's Windows CI job now runs them.
The names cover apostrophes, typographic quotes, mixed quotes, cmd
operators and trailing backslashes.

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

* test(cli): run the cmd.exe round-trip through spawnSync

execFileSync's options type has no windowsVerbatimArguments, so the
Windows-only cmd.exe test failed typecheck. spawnSync takes the option,
and the test now also checks the exit status.

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

* test(cli): expect the quoted Windows path in the relative open command

On Windows a relative path holds a backslash, which shellArg now prints in
double quotes so Git Bash keeps it.

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

* fix(cli): a Windows name with %NAME% or ! prints no path

cmd.exe expands %NAME% inside double quotes, and interactive Git Bash
history-expands ! there, so neither name reads literally in every
Windows shell. Both now take the null fallback. A lone % such as 100%
still prints.

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 06:35:32 +00:00
..
…
2026-11-14 21:38:34 -05: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