Carlos Alcaraz GregorandCarlos Alcaraz
f8abff2e1c
reportApiError centralizes the HyperframesApiError -> Error -> String reporting cascade for the cloud subverbs, including the curated ERROR_CODE_HINTS table and its priority order (code-specific hint > caller suggestion > bare code label > no third line). That priority logic was previously untested; the module comment notes a past regression where hyperframes_render_not_found was unreachable from get/delete. Add errors.test.ts covering: 404 + notFound short-circuit, known-code hint, hint-wins-over-suggestion priority, suggestion fallback, bare code label, no-third-line, extraHints merge and override, plain Error, and non-Error stringification. Mocks errorBox and process.exit following the sibling cloud/parsing.test.ts pattern. Co-authored-by: Carlos Alcaraz <193642530+calcarazgre646@users.noreply.github.com>
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
Related packages
@hyperframes/core— types, parsers, frame adapters@hyperframes/engine— rendering engine@hyperframes/producer— render pipeline@hyperframes/studio— composition editor UI