Files
hyperframes/packages/cli
ukimsanov d34c20fab6 fix: address miguel + rames review on PR #984
Pre-stack fixes covering all 6 of Miguel's code-level issues, plus
the launch-video skill removal and SFX licensing note flagged by
Rames.

- snapshot.ts: `--describe` resolution was contradictory (comment
  said opt-in, code defaulted to "true"). Now: runs by default,
  `--describe "custom Q"` overrides the prompt, `--describe false`
  opts out. Help text updated to match.
- package.json: removed `sharp` from root devDependencies. Already
  declared in packages/cli; root-level was forcing every workspace
  to pull the native binary.
- fontMetadataExtractor.ts: dropped the `as unknown as { ... }` cast
  and the hand-rolled interface. Use `Font | FontCollection` from
  `@types/fontkit` directly + a real type guard. `fsSelection` is
  now typed (italic/oblique booleans, not a raw bitfield), so fontkit
  API drift would surface as a compile error instead of silently
  returning undefined.
- contactSheet.ts: `escapeXml` now also encodes `'` → `'` so
  it's safe for both single- and double-quoted SVG attributes.
- agentPromptGenerator.ts: regex metacharacters in `baseName` are
  now escaped before being interpolated into `new RegExp(...)`.
- screenshotCapture.ts: cookie-dismiss `button[id*="accept"]`-style
  selectors are now scoped under a `[id*="cookie"]` / consent / gdpr
  ancestor. Stops false-positives like "Accept invitation".
- skills/launch-video/: removed. Not part of the website-to-hyperframes
  scope.
- skills/website-to-hyperframes/assets/sfx/CREDITS.md: documents
  Pixabay provenance + license for the 20 bundled .mp3 files.
2026-05-20 13:52:43 -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