miga-heygenandMiguel Ángel
5aa3c8f72f
* fix(cli): connector dash gate honours pathLength `shaftDashHidden` compared the stroke's dash window against `getTotalLength()`, but a `pathLength` attribute rescales every distance along the path, so the CSS draw-on idiom (`<path pathLength="1">` with `stroke-dasharray: 1; stroke-dashoffset: 1`) — which renders zero ink — still fired `connector_detached`. The window is now judged in the author's units: `pathLength` when set (`SVGAnimatedNumber.baseVal`, 0 when unset), the real length otherwise. `dashLength`/`dashArrayLengths` stay the only owners of parsing and units. Two adjacent changes to the gate's arithmetic: - The `total > period` shortcut is removed so the 10% rule applies uniformly. A window that spans a whole period without enclosing a whole dash (`2 97` on a 100-long path at offset 0.5 paints 3%) is hidden, like any other stroke painting under 10%; any pattern that does enclose a whole dash is still caught by the in-loop check. - The dash-offset wrap adds the period only to negative remainders. The previous `((offset % period) + period) % period` is off by one ulp for fractional offsets (`0.9 % 2` → 0.8999…), which flipped the exact 10% boundary once dashes are expressed in `pathLength` units. Tests: rows for `pathLength="1"` (`1/1` hidden, `1/0.9` on the boundary hidden, `1/0.5` painted, `0.1 0.9` round dot painted), a negative offset that only the wrap gets right (`100` at -150), a percentage row (`10%` resolves against the viewport, not as a bare number), and the `2 97` full-period row. `installConnectorGeometry` mirrors the DOM's `pathLength` for happy-dom, which has no SVGGeometryElement. Co-Authored-By: Miguel Ángel <miguel.sierra@heygen.com> * fix(cli): treat a zero pathLength as a solid stroke in the dash gate A present `pathLength` that resolves to 0 (`"0"` or an unparseable value) zeroes the browser's dash scale factor, so the stroke paints solid. The gate saw `baseVal` 0, fell back to the real length, judged the window inside a gap and dropped the shaft, suppressing a real `connector_detached` finding. Return painted for that case. Add a `pathLength=0` row to the dash table and make the happy-dom `pathLength` mirror parse like the DOM (finite SVG number only; `Infinity`, hex, `1.` read as 0). Co-Authored-By: Miguel Ángel <miguel.sierra@heygen.com> * fix(cli): check a zero pathLength before the butt-cap dots shortcut A pathLength resolving to 0 paints the stroke solid, so a butt-capped `0 4` pattern on it is visible; the dots shortcut used to call it hidden first. Also trims the dash-table comment. * test(cli): keep the pathLength helper apart from the geometry installer comment --------- Co-authored-by: Miguel Ángel <miguel.sierra@heygen.com>
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