mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-01 03:06:41 +00:00
Miguel Ángel
36c91cecbb
## Release v0.1.3 Bumps all packages to v0.1.3. ### Changes since v0.1.2 - fix(producer): resolve manifest from sibling dist/ directory - fix(producer): add margin reset when wrapping HTML fragments - fix(producer): exclude test files from tsc build - feat(cli): add opt-out anonymous telemetry via PostHog - feat: add HyperFrames skills for AI coding tools - fix(cli): resolve npx hyperframes from inside monorepo - fix(ci): publish workflow fixes (remove provenance, idempotent steps, remove prepublishOnly) After merging, the release tag is created automatically, which triggers npm publish.
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
dev
Start the live preview studio in your browser:
npx hyperframes dev
# Server running at http://localhost:3000
# Watching for changes...
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.html
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
Upgrade Hyperframes to the latest version:
npx hyperframes upgrade
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