Files
hyperframes/packages/cli
ukimsanov 1b3d2134d3 chore(lint): add fallow-ignore-file for pattern-matching rule code
Lint rule functions in layout.ts and composition.ts are intentionally
deep pattern matchers — branching reflects the variety of CSS/JS shapes
they recognize, not hidden complexity. Refactoring purely to lower CRAP
score would split each rule across multiple helpers and hurt readability
without changing behavior. The same pattern is used in
packages/engine/src/services/frameCapture.ts.

lintProject.test.ts: each test sets up its own HTML fixture via the
standard vitest scaffolding; the surface-level clone is the test-style
shape, not extractable without losing per-test clarity (matches the
clone-families ignore on packages/studio/src/player/components/timelineDragDrop.ts).
2026-06-05 13:58:07 -07:00
..
2026-06-04 22:52:23 +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 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