Files
hyperframes/packages/cli
WaterrrForeverandClaude Opus 5.5 318724f5f4 feat(studio): show the agent's storyboard in a Storyboard tab beside the preview (#7284)
* feat(studio): show the agent's storyboard in a Storyboard tab beside the preview

The board an agent writes per the storyboard recipe (boards/storyboard.html,
or a root storyboard.html) now shows in Studio the way HyperFrames Desktop
shows it: a Preview | Storyboard strip over the preview panel, only while the
project has a board. Studio reads the page's class="frame" boxes into a board
of stills, with acts, titles, times and words, and one frame at a time with
arrow keys. A page with no frames shows as written in a script-less iframe.

A board written while Studio is open brings its tab to the front, as Desktop
does at the agent's stop. A rewrite of the page, a still beside it or
STORYBOARD.md reloads it in place, and a dot marks a rewrite seen from the
preview. "Show in preview" goes back to the film at the frame's start.

Notes, drawings and the go belong to Desktop's agent, so the board's bar
carries the desktop-app button. Its funnel events now say which button was
pressed (placement: header or storyboard).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HebQXPiLcYKQfvPWB3Fgxy

* refactor(studio): split the storyboard view and its frame reader into smaller parts

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HebQXPiLcYKQfvPWB3Fgxy

* docs(skills): the agent's storyboard stop points at the Storyboard tab, not the file

With the board shown beside the preview in Studio as in Desktop, the recipe's
stop and style-sampling's stop 1 tell the person to look in the Storyboard
tab, and to start a preview and give its link when none is running, instead
of handing over boards/storyboard.html to open from disk.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HebQXPiLcYKQfvPWB3Fgxy

* fix(studio): the storyboard listens on Studio's own file-change channel, and its notes are trimmed

The board opened its own /api/events stream, which the Vite dev server
behind the runtime smoke does not serve. It now subscribes through
subscribeFileChanges, the one channel picker the external-change
coordinator already uses (test adapter, Vite HMR, then SSE), so dev and
built Studio deliver the same changes to both.

The new files' comments are cut to the package's share, and the recipe's
Storyboard-tab line moves to the paragraph that names the board, leaving
the stop step as it was.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HebQXPiLcYKQfvPWB3Fgxy

* fix(studio): the board hears file changes through the coordinator, not a second subscription

The external-change coordinator stays the one subscriber to the file-change
transport (HMR in dev, SSE when built), as externalFileChangeOwnership
asserts. It announces each decoded change through fileChangeFanout, and the
storyboard listens there. Mounting EditorShell alone, as its tests do, no
longer opens an EventSource, and the coordinator file stays under the line cap.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HebQXPiLcYKQfvPWB3Fgxy

* feat(studio): the storyboard's Open in desktop app asks the app to open on the board, and its card says why

- The storyboard bar's button posts `doc: "storyboard"` with its page id. The preview server passes only that value
  on, and `openInDesktop` writes it into `.hyperframes/desktop-cta.json` beside the page id, so the app can open the
  project on its Storyboard tab with Build in sight (hyperframes-internal reads it).
- The guide card opened from the storyboard says "Approve this storyboard in the desktop app" and "Comment on a frame,
  draw on it, then press Build", and its last step says the app opens on this storyboard. The header's card is
  unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HebQXPiLcYKQfvPWB3Fgxy

* feat(studio): approve the storyboard in Studio; comments on frames stay in the desktop app

A Studio user without the desktop app had no way to approve the board from the tab, and the bar said approval was
in the desktop app, so the tab read as a dead end. Studio talks to the person's own agent through their chat, so the
bar's Approve copies "The storyboard is approved. Build the video from it." for them to paste to it, and says so in
a toast (or spells the words out when the clipboard refuses). Commenting and drawing on frames stay in the desktop
app. The storyboard recipe tells the agent those pasted words are the person's go.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HebQXPiLcYKQfvPWB3Fgxy

* fix(studio): the storyboard's desktop card offers commenting, since approving now happens in Studio

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HebQXPiLcYKQfvPWB3Fgxy

* fix(studio): hand-off intent before dispatch, steady film under the board, stills outside the board folder

- openInDesktop writes desktop-cta.json before sending the folder, so a running
  app reads the storyboard ask on arrival; a plain or header open drops an
  earlier storyboard ask; a failed open puts the earlier record back.
- PreviewStage keeps the film at one place in the tree with or without a board,
  so a board appearing never remounts it; the automatic switch goes through the
  same pause as a click, and a play while the board is up is paused.
- The board reloads when a still it draws changes, including a root board's
  stills/ and a boards/ page's ../assets.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HebQXPiLcYKQfvPWB3Fgxy

* chore(cli): fit the Storyboard tab in the CLI's size budget; reword a record helper's doc

The CLI tarball carries Studio's build, which now holds the Storyboard tab; merged
with main it measures 7,982,002 bytes packed, 7 bytes past the 1% tolerance.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HebQXPiLcYKQfvPWB3Fgxy

* fix(studio): hold the player while the storyboard covers the film

A pause after the fact let J's reverse loop schedule its next frame, so the
hidden film kept seeking. The stage now takes the player's own hold while the
board is up (and only when no one else holds it), so J, Space and playback
requests are refused before they start; Preview releases it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HebQXPiLcYKQfvPWB3Fgxy

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-06 16:16:21 +00:00
..
2026-11-06 03:19:54 +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: http://localhost:3002/#project/my-video
# Server: http://localhost:3002

npx hyperframes preview --port 4567

In an interactive terminal, the preview stays attached until you press Ctrl+C. In a non-interactive shell such as a coding-agent session, the same command starts a managed preview that survives after the command returns. Use --background or --foreground to choose explicitly, and manage persistent previews with --status, --stop, --list, and --kill-all. Add --json to managed lifecycle commands for machine-readable output. --foreground --json prints the ready-session envelope once, then remains attached until stopped.

audio

Measure where sounds land: onsets, the moment each sound peaks, loudness and silence. Give files, or query the film's own clips in film time:

npx hyperframes audio sfx/whoosh.mp3
npx hyperframes audio --at 12 --json

normalize-audio

Measure two local authored audio clips with integrated LUFS and match the target to the unchanged reference. The command is a dry run unless --write is passed:

npx hyperframes normalize-audio --reference target-audio --target user-audio
npx hyperframes normalize-audio --reference target-audio --target user-audio --write

It updates only the target element's data-volume. Where a full match would pass Studio's +12 dB ceiling or -1.5 dBTP, it applies the most that fits and says how far under the reference that leaves the target.

render

Render a composition to MP4. Run from the project directory; the positional argument is the project directory (not a file), so render the project's index.html directly, or point at a specific composition file with -c:

npx hyperframes render -o output.mp4
npx hyperframes render -c ./my-composition.html -o output.mp4

A render stops when the process that started it exits. To keep one running after its launcher exits, set HYPERFRAMES_RENDER_DETACHED=1 and start it in its own process group, e.g. bash -c 'set -m; HYPERFRAMES_RENDER_DETACHED=1 npx hyperframes render -o out.mp4 < /dev/null > render.log 2>&1 &'.

Piped, non-quiet renders emit a single @hf-diagnostic JSON line when an audio failure reaches the CLI error handler. Version 1 has operation: "render" and at most 16 audioFailures: allowlisted stage, reason, owner, retryable, and optional subprocess exit code, signal, termination reason and OS code. It omits messages, stderr, source paths/URLs, element IDs and command arguments. Consumers must ignore unknown versions and fields. This is local CLI output; uploading it requires the caller's existing consent and privacy checks. Quiet mode (including batch JSON mode) emits no diagnostic line.

This covers audio preparation and mix failures, including the typed external interruption path. Probe failures retain their existing stage/reason but do not gain subprocess evidence here; browser/FX failures remain classified as internal. Desktop ingestion and live report delivery are separate changes.

Piped, non-quiet renders also emit a single @hf-result JSON line after a local render succeeds, never after a failure. Version 1 has operation: "render" and reference_background, the background the render measured from the composition's root and body: {"kind":"solid","rgb":[r,g,b]}, {"kind":"none"}, {"kind":"unsupported_non_solid"} or {"kind":"unknown"}. Consumers must ignore unknown versions and fields. A --docker render prints no result line from the launcher. In batch mode each manifest row carries the same reference_background value (null until the row completes, and for a row that failed).

publish

Upload a project directory and get a hosted URL that keeps working after the CLI exits. Published projects are private by default:

npx hyperframes publish
npx hyperframes publish ./my-video
npx hyperframes publish --public
npx hyperframes publish --yes

Signed-out publishing returns an authentication-required claim URL; opening it lets someone sign in and claim the project. Sign in first with npx hyperframes auth login to publish an owned project you can update. Use --public to make the claimed project visible to anyone. --yes only skips the confirmation prompt and does not change visibility.

Signed-in publishers can use --update <url-or-id> to target an existing project or --space <space-id> to publish into a shared team space. If the requested project is missing or inaccessible, publishing can create a new project instead; check the printed URL and status.

See the publish reference for all options, including video proxy settings.

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

update

Check the CLI and the installed skills for updates in one call, or install both:

npx hyperframes update --check --json  # report only, machine-readable for agents
npx hyperframes update --yes           # upgrade the CLI, then refresh the skills

Documentation

Full documentation: hyperframes.heygen.com/packages/cli