Files
hyperframes/packages/cli
Vance Ingalls 8bfc70e4cb feat(cli): spawn VST sidecar with ready handshake and shutdown
Adds packages/cli/src/vst/sidecar.ts: resolves the vst-host sidecar
command (HF_VST_HOST_CMD override -> monorepo uv run -> bare command
on PATH), spawns `<cmd> serve --port 0`, and resolves once stdout
announces VST-HOST-LISTENING port=<N> (30s timeout with an
`uv tool install` hint). startVstSidecar()/getVstSidecar() are a
per-process singleton.

Wires sidecar teardown into all three `hyperframes preview` launch
paths: registerChildTreeShutdown's signal handler (dev + local studio
modes) and embedded mode's own SIGINT/SIGTERM cleanup + last-resort
exit handler, since embedded mode has no child process to register
with registerChildTreeShutdown. stopVstSidecar() is a safe no-op when
no sidecar is running, so this holds even though the sidecar itself is
started lazily by a later API route (Task 10), not by preview.ts.
2026-07-16 18:51:11 -07: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 running at http://localhost:3002

npx hyperframes preview --port 4567

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

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

Documentation

Full documentation: hyperframes.heygen.com/packages/cli