Files
hyperframes/packages/cli
ukimsanov fefc799177 feat(music): parallel hyperframes music command + background-music.md
PHASE 0b/0c per PLAN.md — music gets its own command surface (Option A,
cleaner UX than `--type music` flag on sfx). Implementation reuses sfx's
auth + analyze modules verbatim, has its own state cache (writes to
assets/music/ not assets/sfx/), and passes type="music" to the same
searchSounds cloud endpoint that backs sfx.

New files:
- packages/cli/src/commands/music.ts (dispatcher, mirrors sfx.ts)
- packages/cli/src/commands/music/{search,add,inspect,state}.ts
- skills/website-to-hyperframes/references/background-music.md

Wired into:
- cli.ts (music subCommands entry)
- help.ts ("AI & Integrations" group)
- step-5-build.md (paragraph linking background-music.md)

Smoke-verified:
- music search "moody ambient pad" returns real catalog tracks (live API)
- music --help shows search/add/inspect
- music inspect resolves clips from assets/music/
- sfx tests still pass (12/12), CLI typecheck clean, full build green
2026-06-11 11:30:43 -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