Files
hyperframes/packages/cli
Michael WangandClaude Opus 5.5 84c7d02a19 fix(cli): keep project folders from choosing the programs and config the CLI runs (#7511)
* fix(cli): resolve helper programs from PATH, never the working directory

On Windows a bare command name is looked up in the working directory before
PATH. The CLI now sets NoDefaultCurrentDirectoryInExePath at startup, which
Node's spawn and cmd.exe both honor and child processes inherit, so tools
such as powershell.exe, taskkill and npx.cmd always come from PATH.

The shared ffmpeg/ffprobe resolver no longer scans the working directory on
Windows and skips relative PATH entries.

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

* fix(cli): keep Python helpers from importing files in the working directory

`python -c` and `python -m` put the working directory first on sys.path, so
a file in the project named like a probed module ran instead of the
installed package. Inline helper code now drops that entry before any
import, and `-m` helpers (pip) run through runpy after the same step. Paths
and arguments are unchanged.

On Windows, findPython also skips a `where` match in the working directory.

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

* fix(cli): run the skills installer and nested CLI calls independent of the project

The global skills install ran `npx skills@<pin>` in the current folder, so
npm could take the package or registry from that project's node_modules or
.npmrc. It now runs from the home folder; the install is global either way.

When the CLI starts the media-use engine it hands over its own entry file.
The local voice fallback and the audio helpers then run that same CLI with
the same Node instead of resolving `npx hyperframes` from the project.
Without a handed-over entry they behave as before.

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

* fix(media-use): load only provider keys from a project .env

The audio scripts copied every key of a project .env into their environment
except two. They now take the same kind of short allowlist the CLI uses:
HeyGen, ElevenLabs and Gemini API keys plus a few harmless settings. Program
overrides, runtime options, credential files and the credential store path
come only from the person's own environment.

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

* fix(cli): build whisper.cpp only from a pinned, verified release

The source-build fallback cloned the upstream default branch. It now clones
the v1.9.5 release tag and refuses to build unless the checkout is the
reviewed commit for that tag.

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

* fix(cli): keep registry caches apart and refuse config install targets

Registry cache file names now include a digest of the exact registry URL,
and each entry records the URL it came from, so one registry's cached
manifest is never read for another. Entries from older versions are
refetched once.

Registry installs refuse targets inside .git or any hidden directory, hidden
configuration files, and package.json, hyperframes.json and
hyperframes.lock.json. An example installed by `init` may still bring its
own package.json and .gitignore.

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

* fix(capture): keep page text to one line in agent files and validate Vertex keys

Capture writes AGENTS.md, CLAUDE.md and .cursorrules from the page's title,
font names and colours. Page text is now flattened to one short line and
colours must be hex values. Existing agent files that capture did not write
are kept, with a warning.

HYPERFRAMES_VERTEX_SERVICE_ACCOUNT must now be a plain service-account key
with a Google token endpoint; other credential types skip captioning with a
warning.

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

* test(cli): find the digest-named registry cache and trim a new file's comment

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

* fix(cli): match registry targets as Windows names them; skills install without HOME

Windows drops trailing dots and spaces from a path segment and reads name:stream as
name, so package.json. or .git./hooks reached the files the target rules refuse.
The global skills install now falls back to the temp folder when HOME does not exist.

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

* fix(cli): turn off the Windows working-directory lookup in every program entry

The warm-check server and client are their own tsup entries and copied the
environment before cli.js set NoDefaultCurrentDirectoryInExePath, so the server
spawned a bare powershell.exe that Windows could take from the project folder.
Every entry that hides child consoles now also loads windowsExeSearch first.

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

* fix(cli): refuse Windows short-name registry targets

A segment like CLAUDE~1 or PACKAG~1.JSO opens the long name on NTFS, so it
reached the files the target rules refuse. The trailing-dot and stream-name
normalization is removed: publication already rejects those segments.

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

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 20:01:19 +00:00
..
2026-11-10 19:56: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