Files
hyperframes/packages/cli
ukimsanovandClaude Opus 4.7 448297e505 Merge origin/main into feat/pipeline-quality-v2
Resolves 7 conflicts:
- .gitignore — kept main's examples/* + AWS Lambda negations, kept branch's repo-root project-dir ignores (huly-*/, raycast-*/, *-demo-*/, test-runs/, test-outputs/), kept main's .claude/worktrees/ etc.
- bun.lock + packages/cli/package.json — took main's esbuild ^0.25.12, kept branch's fontkit ^2.0.4
- packages/cli/src/cli.ts — kept both: main's lambda command + branch's verify-beats command
- packages/cli/src/commands/snapshot.ts — kept branch's version (has sub-composition seek fix from 4ae59e5a)
- packages/producer/src/services/renderOrchestrator.ts — took main's version (main refactored the area my TS fix targeted)
- packages/shader-transitions/src/hyper-shader.ts — took main's version (explicit undefined check + cleaner prog var)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-20 11:35:15 -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