Files
hyperframes/packages/cli
ukimsanov cdbcbfa5f4 feat(sfx): catalog discovery, analysis, and free-key opt-in (#1138)
Cherry-pick of 995dbb4f (originally on feat/sfx-audio-search) into
feat/w2h-restructure-v3, now mergeable because main was just folded
into this branch and brought cloud/auth.

CLI (packages/cli/src/commands/sfx/):
- list / search / add / inspect
- analyze.ts (ffmpeg ebur128 + silencedetect, LUFS/peak/onset/tail
  + loudness sparkline + suggested trim)
- auth.ts (free HeyGen key opt-in instead of raw 401)
- catalog-manifest.ts (180 clips across 22 families, generated)

Skill docs:
- skills/hyperframes/references/sound-effects.md (the global model)
- skills/hyperframes/SKILL.md + beat-direction.md link sound-effects.md
- skills/website-to-hyperframes step-3/step-5 migrate off bundled SFX
  onto catalog flow (incorporates session-13/16 prose: orchestrator
  authoring stays out, landmines stay in)
- assets/sfx/ deleted (20 mp3 + manifest.json + CREDITS.md)

Cherry-pick conflicts resolved manually:
- step-3-storyboard.md SFX section: took catalog version
- step-5-build.md: kept our session-13/16 structure (landmines,
  assembler-owned index.html), folded in commit's catalog-analysis
  paragraph
- manifest.json: deleted per the commit's intent
2026-06-11 02:49:11 -07:00
..
2026-06-11 02:40:36 +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