Files
hyperframes/packages/cli
Miguel Ángel 17cd11d465 fix(cli): serialize port-availability probes (#309)
testPortOnAllHosts ran the four host probes (127.0.0.1 / 0.0.0.0 / ::1 / ::)
in parallel via Promise.all. The first bind on 127.0.0.1 held its socket
open until server.close() resolved on the next event-loop tick, and while
it was open the wildcard 0.0.0.0 / :: probes raced it and got EADDRINUSE.
Result: every port in the 3002–3101 scan range looked occupied and the
preview server refused to start — deterministic on Linux (Crostini on
ChromeOS in the reporting environment, gigadeniga's issue #309).

Fix is to test the hosts sequentially so each probe's socket is fully
closed before the next opens. The multi-host check itself stays — it's
load-bearing for devbox / SSH-forwarding layouts where a port is free
on loopback but held on the wildcard.

Regression tests bind real sockets (no mocks) and would have failed
against the parallel implementation on any Linux shard.
2026-04-17 23:59:35 +02:00
..
2026-04-17 12:15:37 +02:00
2026-03-21 22:43:56 -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:

npx hyperframes render ./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