* feat(cli): let transcribe --to write srt or vtt straight from a media file * fix(cli): fail a missing transcribe --output folder before decoding * fix(cli): reject a transcribe --output that names a folder * test(cli): check CJK caption grouping on the parsed cues * fix(cli): keep transcribe --output from overwriting the media or its transcript - Refuse an --output that resolves to the input file or the transcript.json the run writes, before the engine starts. - When the caption file cannot be written after transcribing, say the transcript was saved and name the caption path and reason, instead of reporting a failed transcription. - Docs: a one-run export groups cues for languages without spaces; exporting the saved transcript later may split them differently. * fix(cli): refuse caption paths that alias the media or transcript - The overwrite check compares files, not path text: an existing target is matched by device and inode, a new one by its real folder and its name ignoring letter case. Links, folder aliases such as /var and /private/var, and other letter case are all refused. - The check also covers the default caption path, so exporting transcript.srt to srt no longer rewrites its own input. - A trailing -o with no path fails before transcribing. - One constant names transcript.json for the engines, the import and the check. * fix(cli): refuse caption links to the transcript before it exists - A caption path that is a link is followed to where the write would land, so a link to the transcript.json the run is about to create is refused before transcribing. - A test pins the folder letter-case check on a case-insensitive disk, and says which branch ran. * fix(cli): check the caption file against the transcript right before writing it - Right before the caption write, by when the transcript exists, a destination that is the same file as the input or transcript.json is refused. The OS resolves every link, relative link and alias, so the hand-written link following is gone. - The run keeps the transcript and says the caption file could not be written and why. An export whose caption write fails now says so too, instead of crashing. - The check before transcribing stays as an early refusal for the common cases. * fix(cli): compare caption paths by name when the disk reports no inode - Some network shares report inode 0 for every file; such a pair is compared by folder and name instead of being called the same file. The check before transcribing and the one at write time now share one comparison. - The link-through-a-file tests accept ENOENT as well as ENOTDIR, the code Windows reports. * fix(cli): resolve both caption paths fully when the disk reports inode 0 - When either file reports inode 0 and both exist, compare their fully resolved real paths, so a link to the media or the transcript is still refused. The folder and name compare stays for a path that does not exist yet. - Tests zero the inode on every path, on the caption path only, or on the protected file only. * test(cli): say plainly why the caption-write test accepts two error codes
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.
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 and refuses unsafe boosts
that exceed Studio's +12 dB ceiling or would clip.
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
Set HYPERFRAMES_RENDER_DETACHED=1 when starting a render with nohup or
disown so it keeps running after the invoking shell exits.
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
Documentation
Full documentation: hyperframes.heygen.com/packages/cli
Related packages
@hyperframes/core— types, parsers, frame adapters@hyperframes/engine— rendering engine@hyperframes/producer— render pipeline@hyperframes/studio— composition editor UI