mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-03 04:38:33 +00:00
* feat(studio,cli): per-frame board comments, self-refreshing storyboard, status-aware preview landing Per-frame comment boxes on the storyboard board batch into .hyperframes/frame-comments.json (a resubmit wins per frame; unconsumed comments on other frames are kept). Submitted-but-unconsumed comments stay visible — a toolbar banner plus a per-tile echo — until the agent consumes the file; the banner also says what to do next (reply anything in the agent chat). The board keeps itself current: GET /projects/:id/signature exposes the watcher-cached project signature, the storyboard payload carries the signature it was derived from, and the view polls at 2s (hidden tabs skipped, re-checked on visibility), refetching in place with no loading flash. Posters bake the signature into their URL so tiles fill in as sketches land and a poster that failed mid-write retries on the next version; the empty state upgrades itself when STORYBOARD.md appears, and its handoff prompt now points the agent at the review loop and uses the parser's real status vocabulary (outline, not planned). preview lands the browser on the storyboard view while the board is the review surface — any frame built, or pure planning (srcs declared, none on disk yet) — and on the timeline once the video is assembled. * feat(skills): the review loop — plan, sketch, build as one shared process hyperframes-core/references/review-loop.md is the single source for the three-pass collaborative review: the plan proposed on a live board (§ 1), wireframe sketches marked built with one layout question (§ 2 — real words on plain blocks, run no CLI; a confirmed board is itself a valid deliverable when the user asked for a storyboard, not a video), the build dressing confirmed layouts (§ 3, worker or inline), and the final look (§ 4). Autonomous runs skip every gate and keep one question before render. The three narrative workflows' Steps 3/4/6 collapse to references plus their sketch stand-ins (captured-asset blocks for product-launch-video, plain code panels for pr-to-video); the confirmed-sketch handoff stays in each frame-worker prompt. general-video plans on a board for multi-scene narrative pieces in collaborative mode — its sketch pass is layout-before-animation with the user watching. The router treats "I want a storyboard" as a process request rather than a route, and closes exploratory intake by recommending a route plus how the run will review. The supporting contracts land next door: the comments channel (silent submit, one reply picks it up, check the file before the words) in brief-contract § 1; the sidecar schema and the built status rung in storyboard-format; the mode question asked first and alone in the three workflows' Step 0. * feat(media-use): user memory — remembered preferences and frozen recipes Two tiers of memory on media-use's existing two-tier storage split. Preferences (lightweight): confirmed brief answers — destination, aspect, language, mode, voice, style preset — recorded to the project's .media/preferences.json (committed, the team inherits it) and promoted to the personal ~/.media/preferences.json once the same value is confirmed in two different projects (a sightings ledger accumulates the cross-project evidence user-side, since project files can't see each other). prefs.mjs get/record; merge reads project-over-user; a changed value restarts its provenance. Recipes (heavyweight): one approved run frozen as a named, versioned bundle — frame.md, the storyboard skeleton (structure kept: durations, transitions, srcs, Video direction; statuses reset to outline; content blanked to per-frame fill-ins naming the beat's role), and the confirmed brief values. Named folders, not content hashes: re-freezing bumps version and archives <name>@v<N>; a freeze is already confirmed, so it promotes to the user tier immediately. recipe.mjs freeze/list/use, plus resolve --type recipe --entity <name> delegating like grade/lut. 16 new node --test cases; the media-use lib suite is 168/168. * feat(skills): wire user memory into the brief and the review loop brief-contract § 2 gains Remembered defaults: read the merged preferences before Round 2 and let a remembered value become the recommended option with a receipt naming its source project. Memory changes the default, never the question — every ask-marked field still gets asked, and what the request says this time beats what was picked last time. Record only what the user actually confirmed (a defaulted voice nobody chose is not an answer; a "go" that accepts the recommended defaults is). The first record announces itself once; after that the receipts carry the reminder. In autonomous mode a remembered value becomes the decided value, receipt included. The three narrative workflows read the remembered defaults before Round 2, record the confirmed answers at the Step 0 gate, record the chosen preset at the Step 2 gate (pr-to-video excepted — its preset is fixed), and fall back to the remembered voice when the request names none. general-video's discovery reads the same defaults. Recipes wire in at both ends: Step 0 checks for a matching recipe before the mode question — one question, plural-aware, and adopting one fills the brief, skips the design step, and drafts the storyboard from the frozen skeleton while every review gate still runs. The review loop's final look (§ 4) offers the freeze once after approval, and the confirmation teaches the recall phrase — the name is something the system reminds the user of, never something they must remember. The router recognizes a named recipe or "like last time" as a route. * docs(skills): the sketch pass names check, not the deprecated validate * feat(skills): intent-layer references — process, route briefs, capability menu, BRIEF.md format * feat(media-use): brief skeleton as the recipe's fourth artifact; flow/storyboard preference keys * feat(skills): the intent layer conducts every brief — workflows execute BRIEF.md * feat(skills): retire the mode preference key; sync catalog surfaces for intent layer * refactor(skills): dedupe router vs intent-layer guidance — one owner per rule * feat(skills): the design ask — own spec, pick by eye from showcases, or defer * docs(skills): the design ask says the honest line on capture routes * feat(skills): product-launch-video absorbs website-to-video as the tour angle * refactor(skills): keep product-launch-video pristine — a tour is brief intent, not a pipeline branch * feat(skills): production loop + genre lenses; general-video goes freeform (route yours, laws hold) * refactor(skills): /hyperframes is the front door - route tables and scope lists leave the workflows * docs(skills): review-loop pass across skill catalog * fix(cli): pass project dir to openStudioBrowser in background-server path * feat(skills): add pitch-round reference - verbalized sampling concept gate * feat(skills): wire pitch round into intent layer - completeness triage + route eligibility * feat(skills): editorial capability recommendations, handoff disciplines, menu-probe split * feat(skills): pitches carry their machinery; source-only-formed requests pitch the telling * feat(skills): companion goes director - ceiling treatment plus blueprint/rule citation discipline * fix(scripts): sandbox npx-leak guard - private npm global prefix keeps npx on the branch CLI * chore(skills): resync manifest hash after formatter pass reflowed general-video tables * fix(skills): recipe freeze reads workflow from BRIEF.md; style_preset records require workflow scope Two holes found by a live companion-run freeze: the agent-supplied --workflow contradicted the run's actual workflow (recipe.json said faceless-explainer, brief-skeleton said general-video), and the style_preset lookup missed because the preference had been recorded under the bare key. - freezeRecipe resolves the workflow from BRIEF.md frontmatter; the flag is a fallback for briefless projects and a contradicting flag is ignored (noted). - recordPreference refuses a bare style_preset — the scoped key is the only writable shape; freeze tolerates legacy bare records via read fallback. - review-loop § 4 / media-use SKILL / brief-format wording follow the machinery.
239 lines
9.7 KiB
Plaintext
239 lines
9.7 KiB
Plaintext
---
|
||
title: Website to Video
|
||
description: "Capture any website and turn it into a production video with a single prompt."
|
||
---
|
||
|
||
Give your AI agent a URL and a creative direction. It captures the site, extracts the brand identity, writes a script and storyboard, generates voiceover, builds animated compositions, and delivers a renderable video.
|
||
|
||
```
|
||
"Create a 20-second product launch video from https://linear.app.
|
||
Make it feel like an Apple keynote announcement."
|
||
```
|
||
|
||
## Getting Started
|
||
|
||
<Steps>
|
||
<Step title="Install skills">
|
||
Skills teach your AI agent how to capture websites and create HyperFrames compositions. Install once — they persist across sessions.
|
||
|
||
```bash
|
||
npx skills add heygen-com/hyperframes
|
||
```
|
||
|
||
Works with [Claude Code](https://claude.ai/claude-code), [Cursor](https://cursor.sh), [Gemini CLI](https://github.com/google-gemini/gemini-cli), and [Codex CLI](https://github.com/openai/codex).
|
||
</Step>
|
||
<Step title="Prompt your agent">
|
||
Open your agent in any directory and describe the video you want:
|
||
|
||
```
|
||
Create a 25-second product launch video from https://example.com. Bold, cinematic, dark theme energy.
|
||
```
|
||
|
||
The agent loads the skill when they see a URL and a video request, and runs the full pipeline — capture, design, strategy & messaging, storyboard + script, voiceover, build, validate.
|
||
|
||
<Note>
|
||
Agents also trigger this skill automatically when they see a URL and a video request.
|
||
</Note>
|
||
</Step>
|
||
<Step title="Preview">
|
||
```bash
|
||
npx hyperframes preview
|
||
```
|
||
|
||
Opens the video in your browser. Edits reload automatically.
|
||
</Step>
|
||
<Step title="Render to MP4">
|
||
```bash
|
||
npx hyperframes render --output my-video.mp4
|
||
```
|
||
|
||
```
|
||
✓ Captured 750 frames in 12.4s
|
||
✓ Encoded to my-video.mp4 (25.0s, 1920×1080, 6.8MB)
|
||
```
|
||
</Step>
|
||
</Steps>
|
||
|
||
<Note>
|
||
You don't need to run `npx hyperframes capture` manually — the skill instructs the agent to capture as the first step. The capture command is documented [below](#capture-command) for advanced use.
|
||
</Note>
|
||
|
||
## How the Pipeline Works
|
||
|
||
The skill follows the [Hyperframes pipeline](/guides/pipeline): seven steps, each producing a named artifact that feeds the next.
|
||
|
||
| Step | Output | What happens |
|
||
|------|--------|-------------|
|
||
| **Capture** | `capture/` | Extract screenshots, design tokens, fonts, assets, animations |
|
||
| **Design** | `DESIGN.md` | Brand reference — colors, typography, component stylings, spacing, iteration guide |
|
||
| **Strategy & Messaging** | — | Align on video type, style, the ONE message, and narrative arc |
|
||
| **Storyboard + Script** | `STORYBOARD.md` + `SCRIPT.md` | Concept-first storyboard and narration script, written together |
|
||
| **VO + Timing** | `narration.wav` + `transcript.json` | TTS audio with word-level timestamps |
|
||
| **Build** | `compositions/*.html` | Animated HTML compositions, one per beat |
|
||
| **Validate** | Snapshot PNGs + lint/validate pass | Visual verification and runtime checks before delivery |
|
||
|
||
See [the pipeline guide](/guides/pipeline) for a detailed walkthrough of each step, the contents of every generated file, and how to iterate without re-running the whole pipeline. The structure is useful for any Hyperframes project, not just website captures.
|
||
|
||
## Video Types
|
||
|
||
The prompt determines the format. Include a duration and creative direction:
|
||
|
||
| Type | Duration | Example |
|
||
|------|----------|---------|
|
||
| Social ad | 10–15s | _"15-second Instagram reel. Energetic, fast cuts."_ |
|
||
| Product demo | 30–60s | _"45-second demo showing the top 3 features."_ |
|
||
| Feature announcement | 15–30s | _"Feature announcement highlighting the new AI agents."_ |
|
||
| Brand reel | 20–45s | _"30-second brand video. Celebrate the design."_ |
|
||
| Launch teaser | 10–20s | _"12-second teaser. Super minimal. Just the hook."_ |
|
||
|
||
<Tip>
|
||
Creative direction matters more than format. _"Playful, hand-crafted feel"_ or _"dark, developer-focused, show code"_ shapes the storyboard and drives every visual decision the agent makes.
|
||
</Tip>
|
||
|
||
## Enriching Captures with Gemini Vision
|
||
|
||
By default, captures describe assets using DOM context — alt text, nearby headings, CSS classes. Add a vision API key for richer AI-powered descriptions.
|
||
|
||
Create a `.env` file in your project root with **either** a [Gemini API key](https://aistudio.google.com/apikey):
|
||
|
||
```bash
|
||
echo "GEMINI_API_KEY=your-key-here" > .env
|
||
```
|
||
|
||
…**or**, if you don't have Google access, an [OpenRouter key](https://openrouter.ai/keys) — a single API that fronts many vision models:
|
||
|
||
```bash
|
||
echo "OPENROUTER_API_KEY=your-key-here" > .env
|
||
```
|
||
|
||
OpenRouter is used when its key is present (it takes priority if both are set). The default model is `google/gemini-3.1-flash-lite`; override it with `HYPERFRAMES_OPENROUTER_MODEL` (any vision-capable OpenRouter model), just as `HYPERFRAMES_GEMINI_MODEL` overrides the Gemini default.
|
||
|
||
<Tabs>
|
||
<Tab title="Without Gemini">
|
||
```
|
||
- hero-bg.png — 582KB, section: "Hero", above fold
|
||
```
|
||
The agent knows the file exists and where it was on the page, but not what it looks like.
|
||
</Tab>
|
||
<Tab title="With Gemini">
|
||
```
|
||
- hero-bg.png — 582KB, A gradient wave in purple and blue sweeps
|
||
across a dark background, creating an aurora-like effect.
|
||
```
|
||
The agent knows what the image actually shows, enabling better creative decisions in the storyboard.
|
||
</Tab>
|
||
</Tabs>
|
||
|
||
| Tier | Rate limit | Cost per image |
|
||
|------|-----------|----------------|
|
||
| Free | 5 RPM | Free |
|
||
| Paid | 2,000 RPM | ~$0.001 |
|
||
|
||
A typical capture with 40 images costs about **$0.04** on the paid tier.
|
||
|
||
## Capture Command
|
||
|
||
The skill runs capture automatically, but you can run it directly for pre-caching, debugging, or using the data outside of video production.
|
||
|
||
```bash
|
||
npx hyperframes capture https://stripe.com
|
||
```
|
||
|
||
```
|
||
◇ Captured Stripe | Financial Infrastructure → capture
|
||
|
||
Screenshots: 12
|
||
Assets: 45
|
||
Sections: 15
|
||
Fonts: sohne-var
|
||
```
|
||
|
||
| Flag | Default | Description |
|
||
|------|---------|-------------|
|
||
| `-o, --output` | `./capture` | Output directory (auto-suffixes to `./capture-2/`, `./capture-3/`, … if `./capture/` is taken) |
|
||
| `--timeout` | `120000` | Page load timeout in ms |
|
||
| `--skip-assets` | `false` | Skip downloading images and fonts |
|
||
| `--max-screenshots` | `24` | Maximum screenshot count |
|
||
| `--json` | `false` | Output structured JSON for programmatic use |
|
||
|
||
### What Gets Captured
|
||
|
||
| Data | Description |
|
||
|------|-------------|
|
||
| **Screenshots** | Viewport captures at every scroll depth — dynamic count based on page height |
|
||
| **Colors** | Pixel-sampled dominant colors + computed styles, including oklch/lab conversion |
|
||
| **Fonts** | CSS font families + downloaded woff2 files |
|
||
| **Assets** | Images, SVGs with semantic names, Lottie animations, video previews |
|
||
| **Text** | All visible text in DOM order |
|
||
| **Animations** | Web Animations API, scroll-triggered animations, WebGL shaders |
|
||
| **Sections** | Page structure with headings, types, background colors |
|
||
| **CTAs** | Buttons and links detected by class names and text patterns |
|
||
|
||
## Snapshot Command
|
||
|
||
Capture key frames from a built video as PNGs — verify compositions without a full render:
|
||
|
||
```bash
|
||
npx hyperframes snapshot my-project --at 2.9,10.4,18.7
|
||
```
|
||
|
||
| Flag | Default | Description |
|
||
|------|---------|-------------|
|
||
| `--frames` | `5` | Number of evenly-spaced frames |
|
||
| `--at` | — | Comma-separated timestamps in seconds |
|
||
| `--timeout` | `5000` | Ms to wait for runtime to initialize |
|
||
|
||
## Iterating
|
||
|
||
You don't need to re-run the full pipeline to make changes:
|
||
|
||
- **Edit the storyboard** — `STORYBOARD.md` is the creative north star. Change a beat's mood or assets, then ask the agent to rebuild just that beat.
|
||
- **Edit a composition** — open `compositions/beat-3-proof.html` directly and tweak animations, colors, or layout.
|
||
- **Rebuild one beat** — _"Rebuild beat 2 with more energy. Use the product screenshot as full-bleed background."_
|
||
|
||
See the [pipeline guide](/guides/pipeline#iterating) for more re-entry patterns.
|
||
|
||
## Troubleshooting
|
||
|
||
<AccordionGroup>
|
||
<Accordion title="Capture times out">
|
||
Increase the timeout for sites with Cloudflare or heavy client-side rendering:
|
||
|
||
```bash
|
||
npx hyperframes capture https://example.com --timeout 180000
|
||
```
|
||
</Accordion>
|
||
<Accordion title="Few assets captured">
|
||
Sites using frameworks like Framer lazy-load images via IntersectionObserver. The capture scrolls through the page to trigger loading, but very long pages may miss images near the bottom. Adding a Gemini key improves descriptions of captured assets, but doesn't increase the count.
|
||
</Accordion>
|
||
<Accordion title="Colors look wrong">
|
||
The capture uses pixel sampling combined with DOM computed styles. Dark sites should show dark colors in the palette. Check the scroll screenshots in `<output>/screenshots/` (default `./capture/screenshots/`) to see what the capture actually saw.
|
||
</Accordion>
|
||
<Accordion title="Agent doesn't find the skill">
|
||
Verify skills are installed:
|
||
|
||
```bash
|
||
npx skills add heygen-com/hyperframes
|
||
```
|
||
|
||
Lead your prompt with _"Use the /product-launch-video skill"_ for the most reliable results — site tours route there too. Agents also discover it automatically when they see a URL and a video request.
|
||
</Accordion>
|
||
</AccordionGroup>
|
||
|
||
## Next Steps
|
||
|
||
<CardGroup cols={2}>
|
||
<Card title="The Pipeline" icon="list-check" href="/guides/pipeline">
|
||
The canonical 7-step structure this workflow follows.
|
||
</Card>
|
||
<Card title="Quickstart" icon="rocket" href="/quickstart">
|
||
New to HyperFrames? Start here.
|
||
</Card>
|
||
<Card title="GSAP Animation" icon="wand-magic-sparkles" href="/guides/gsap-animation">
|
||
Animation patterns used in compositions.
|
||
</Card>
|
||
<Card title="Rendering" icon="film" href="/guides/rendering">
|
||
Render to MP4, MOV, or WebM.
|
||
</Card>
|
||
</CardGroup>
|