mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-14 18:01:20 +08:00
Miguel Ángel
0f8eb892e3
* fix(motion-graphics): make the catalog search fire before hand-authoring
The workflow's only reuse instruction pointed at catalog-map.md, a
hand-maintained snapshot of ~60 registry items, and no file in the skill
ever named `hyperframes catalog --query`. An agent asked mid-build for
CRT scanlines and a glitch effect had no instruction to search, so it
hand-authored both while caption-glitch-rgb ("RGB chromatic aberration
with CRT scanline overlay") ranks first for that query on either tier.
The search reads the hosted registry and needs nothing installed, from
any directory with no project, so "the components were not installed"
was never the cause. Say that where the reader is, since the wrong
diagnosis is the intuitive one.
Director Part 2 and the Builder now run the search before naming a
block, and catalog-map.md is labelled a partial snapshot whose misses
prove nothing. Pinned by a content test in coreSkillContent.test.ts.
* fix(skills): search the component catalog before hand-building a look
Authoring workflows never told the agent to search the component library,
so agents rebuilt effects the registry already shipped. A user reported
building an effect from scratch that the registry already contained; the
search that would have found it needs nothing installed, which is why the
usual self-diagnosis ("I forgot to install the components") is wrong.
All ten workflow skills carried zero mentions of `hyperframes catalog`.
The instruction lived only in hyperframes-cli and hyperframes-registry,
both loaded on demand, and the registry skill's own trigger named the
command rather than the symptom - circular, because an agent that never
thought to search could not reach the doc telling it to search.
- Eight workflows now run the search at the point they decide what to
build, before authoring. The two that compile through a closed
authoring vocabulary (embedded-captions, talking-head-recut) document
why they deliberately do not.
- hyperframes-registry triggers on the symptom (a named look, effect,
treatment or transition) instead of the command name; the router table
and the catalog surfaces carry the same framing.
- Fixes hand-maintained lists that had drifted: bar-chart-race was listed
as a hand-author gap in two files while shipping in the registry;
stat-motion was named as an installable block and is not one; the
caption-* family count was one high; the registry discovery tables
claimed to be the block list while covering 97 of 180.
- bun run lint:skills now fails when a doc marked as a registry snapshot
names an item the registry does not have.
* refactor(scripts): reuse native recursive readdir and the shared registry type
Simplify pass on the new registry-snapshot check, behaviour identical:
- collectMarkdownFiles uses readdirSync({ recursive: true }) instead of
hand-rolled recursion, matching scripts/generate-template-previews.ts.
- registryItemNames types registry.json with the exported RegistryManifest
instead of an ad hoc inline shape, matching scripts/catalog/build-local-vectors.ts.
The runtime guard stays: a cast describes the file, it does not validate it.
- One report() helper replaces the duplicated print-and-count block in both
lint passes.
* refactor(scripts): name the registry check's blind spots and stop self-arming
Applies the review findings on the new check, behaviour identical except
where noted:
- lintRegistryItemRefs returns null for an unmarked file instead of an
empty array, so "not a snapshot" and "a clean snapshot" have one owner
and the marker is matched once rather than twice.
- Marker detection ignores fenced blocks, so a doc that documents the
marker syntax in an example no longer arms the check on itself. The id
scan still reads full content, so fenced examples stay covered.
- The header comment and two tests now pin both known false negatives:
identifiers outside backticks, and single-word item names. Measured on
the six marked files, dropping the hyphen requirement would monitor 3
more items and force 46 allow= entries for ordinary prose words, so the
requirement stays and the gap is stated instead of silent.
* chore(skills): regenerate skills manifest after catalog-search edits
194 lines
15 KiB
Plaintext
194 lines
15 KiB
Plaintext
---
|
|
title: Prompt Guide
|
|
description: "How to prompt AI agents to author HyperFrames videos — setup, the two prompt shapes, and the map of this guide."
|
|
---
|
|
|
|
import { DocsVideo } from "/snippets/docs-video.jsx";
|
|
|
|
<DocsVideo
|
|
title="HyperFrames video: Capstone Timeline Default"
|
|
src="https://static.heygen.ai/hyperframes-oss/docs/images/prompting/capstone-timeline-default-v2.mp4#t=0.1"
|
|
loop
|
|
/>
|
|
*By the end of this guide, you can build this with a prompt.*
|
|
|
|
HyperFrames is built for AI agents — compositions are plain HTML, the CLI is non-interactive, and the framework ships [skills](https://github.com/vercel-labs/skills) that teach agents the patterns docs alone don't cover. This guide shows how to prompt agents effectively once skills are installed — the vocabulary that changes output, the iteration patterns that save time, and the rules that prevent breakage.
|
|
|
|
<Note>
|
|
**Before you prompt**, have three things in place: the skills installed (below), a scaffolded project (`npx hyperframes init my-video`), and the live preview running (`npx hyperframes preview`) so you can judge each render the moment it lands. Prompting without the preview open turns every iteration into a blind guess.
|
|
</Note>
|
|
|
|
## The level ladder
|
|
|
|
The guide is one arc, novice to advanced. Each level is what you can do once you've read it — read them in order, or jump straight to whichever gap matches where you are:
|
|
|
|
| Level | What you can do after it |
|
|
| --- | --- |
|
|
| **1 — [Your first video](/prompting/product-launch)** | Get a finished video from one prompt — the workflow fills the gaps (palette, pacing, structure) for you. |
|
|
| **2 — [Control](/prompting/anatomy)** | Name the parts yourself: route, spec, beats, copy, technique, negatives — the skeleton that removes the decisions agents get wrong. |
|
|
| **3 — [Life](/prompting/motion)** | Motion and transitions that read premium instead of like a slideshow. |
|
|
| **4 — [Substance](/prompting/code-blocks)** | Add real capabilities: code animation, data-viz, overlays, captions, generated artwork, VFX, 3D. |
|
|
| **5 — [Voice & sound](/prompting/media-and-audio)** | Narration, music, and any footage you supply, scored and mixed correctly. |
|
|
| **6 — [Scale](/prompting/design-systems)** | Design systems, variables, storyboards, editing, iterating, matching references, and export — a video as a system, not a one-off. |
|
|
| **7 — [Capstone](/prompting/capstone)** | Everything above, composed into one real prompt. Each chapter on the way up shows its own region of this film cut out in isolation; the capstone prompt is the glue that binds them into one continuous camera journey, rendered twice from one template. |
|
|
|
|
## One-time setup
|
|
|
|
Install the skills in your project (or globally for your agent):
|
|
|
|
```bash
|
|
npx skills add heygen-com/hyperframes
|
|
```
|
|
|
|
The installer shows a picker. Select the **core skills** below — every project needs them. In Claude Code, restart the session after installing; the skills register as **slash commands**. Start at `/hyperframes`: it orients you to the whole surface and routes "make me a video" requests to the right workflow.
|
|
|
|
**Core skills — install all of these**
|
|
|
|
| Slash command | What it loads |
|
|
| ----------------------- | -------------------------------------------------------------------------- |
|
|
| `/hyperframes` | **Read first.** The entry skill — capability map + video router; sends "make me a video" intent to the right workflow |
|
|
| `/hyperframes-core` | Composition contract — HTML structure, `data-*` attributes, clips, tracks |
|
|
| `/hyperframes-animation`| All animation — motion rules, scene blueprints, transitions, and the runtime adapters (GSAP, Lottie, Three.js, Anime.js, CSS, WAAPI, TypeGPU) |
|
|
| `/hyperframes-creative` | Creative direction — design spec, palettes, typography, narration, beats |
|
|
| `/hyperframes-cli` | Dev-loop CLI — `init`, `lint`, `check`, `preview`, `render`, `doctor` |
|
|
| `/media-use` | Media OS — TTS voiceover (`tts`), `transcribe`, `remove-background`, plus BGM / SFX / image resolution |
|
|
| `/hyperframes-registry` | Search the catalog before hand-building a look; install via `hyperframes add` |
|
|
| `/hyperframes-keyframes`| Seek-safe keyframe authoring across runtimes, plus `hyperframes keyframes` diagnostics |
|
|
| `/general-video` | The general authoring workflow — multi-scene pieces, reels, montages, remixes, and the home of **companion mode**; the fallback when no workflow below fits |
|
|
|
|
**Optional workflows — add the ones that match your inputs** (`/hyperframes` routes to whichever you've installed)
|
|
|
|
| Slash command | Input → output |
|
|
| ------------------------ | --------------------------------------------------------------------------- |
|
|
| `/product-launch-video` | Any website URL / brief / script → launch or promo video, or a site tour / showcase |
|
|
| `/faceless-explainer` | Arbitrary text (no URL, no footage) → faceless explainer — every visual invented (typography, diagrams, data-viz) |
|
|
| `/pr-to-video` | A GitHub PR → code-change explainer |
|
|
| `/embedded-captions` | An existing talking-head video → the same footage with captions / subtitles |
|
|
| `/talking-head-recut` | An existing talking-head video → footage packaged with transcript-synced graphic overlays (kinetic titles, lower-thirds, PiP) |
|
|
| `/motion-graphics` | A logo / stat / tweet / brief → a short (~10s) unnarrated motion graphic (kinetic type, count-up, logo sting) — MP4 or transparent overlay |
|
|
| `/music-to-video` | A music track — a file, a video's audio, or one generated from a mood brief → beat-synced video (lyric / slideshow / kinetic promo); your images optional, cut on the beat |
|
|
| `/slideshow` | A deck outline or slides → navigable presentation with presenter mode (not a rendered MP4) |
|
|
| `/remotion-to-hyperframes` | Port an existing Remotion (React) composition to HyperFrames HTML |
|
|
| `/figma` | A Figma file / frame / URL → imported assets, brand tokens, and reconstructed motion |
|
|
|
|
<Tip>
|
|
To skip the picker and install everything (core + every workflow) in one shot, run `npx hyperframes skills`. And start HyperFrames prompts with `/hyperframes` (or invoke the skill another way for non-Claude agents) — it loads the routing + composition context explicitly so the agent picks the right workflow and gets the rules right the first time.
|
|
</Tip>
|
|
|
|
|
|
|
|
## Claude Design
|
|
|
|
Claude Design uses a different setup. Download [`claude-design-hyperframes.md`](https://github.com/heygen-com/hyperframes/blob/main/docs/guides/claude-design-hyperframes.md) from GitHub (click the ↓ button), then **attach it to your chat** (don't paste the URL — file attachments produce better output):
|
|
|
|
```text
|
|
Use the attached skill. 25-second LinkedIn video for my startup.
|
|
|
|
Problem: Sales teams waste 3 hours/day on manual CRM updates.
|
|
Solution: AutoCRM — AI that logs every call, email, and meeting.
|
|
Traction: 200+ teams, $1.2M ARR, 18% MoM growth.
|
|
CTA: autocrmhq.com
|
|
```
|
|
|
|
Claude Design produces a valid first draft (brand identity, scene content, animations, transitions). Download the ZIP and refine in any AI coding agent with `npx hyperframes preview` running. See the [Claude Design guide](/guides/design-tools) for the full workflow.
|
|
|
|
|
|
|
|
## The two prompt shapes
|
|
|
|
Most successful HyperFrames prompts fall into one of two shapes.
|
|
|
|
**Cold start — describe the video.** You tell the agent what you want from scratch — best for greenfield work where you already have the creative direction in your head.
|
|
|
|
> Using `/hyperframes`, create a 10-second product intro with a fade-in title over a dark background and subtle background music.
|
|
|
|
Cold-start prompts work best when you specify **duration** ("10 seconds", "5 scenes of 3s each"), **aspect ratio** ("16:9", "9:16 vertical" — defaults to 1920x1080 otherwise), **mood / style** ("minimal Swiss grid", "high-energy social"), and **key elements** (title, lower third, captions, music).
|
|
|
|
**Warm start — turn context into a video.** You give the agent something to work with — a URL, a doc, a CSV, a transcript — and ask it to synthesize that into a video. This is where HyperFrames shines because the agent does the research/summarization step *and* the production step in one flow.
|
|
|
|
> Take a look at this GitHub repo https://github.com/heygen-com/hyperframes and explain its uses and architecture to me using `/hyperframes`.
|
|
|
|
> Turn this CSV into an animated bar chart race using `/hyperframes`.
|
|
|
|
Warm-start prompts produce richer, more grounded videos because the agent is writing about *something specific* instead of inventing copy.
|
|
|
|
The four prompts above illustrate shape, not results — every prompt in this guide that ships with an embedded render was run exactly as written, and the gallery of those lives in [Verified examples](/prompting/examples).
|
|
|
|
## The interview: what the agent asks first
|
|
|
|
Either shape starts a short interview before anything is built. This isn't the agent stalling — it's the intent layer turning "make me a video" into a confirmed brief, so the build never has to guess the things you'd have corrected afterward. The agent confirms the route, then asks that workflow's must-have questions (recommended answer first, so most are one-word confirmations). When the selected workflow supports both run shapes, it then closes with two questions that shape the run itself:
|
|
|
|
| Question | Your options |
|
|
| --- | --- |
|
|
| **Storyboard?** | `yes` — review the plan, wireframe sketches, and the build pass by pass on a live board (recommended past a couple of scenes) · `no` — one finished video from the confirmed brief |
|
|
| **Automation or companion?** | `automation` — the matched workflow's pipeline executes the brief end to end · `companion` — build it together in `/general-video` with every HyperFrames capability on the table |
|
|
|
|
The two are independent — all four combinations are valid, and a companion run reviews on the live board too when you said yes to the storyboard. Four routes skip both questions because neither has anything to add: `/motion-graphics` (the piece is seconds long), `/slideshow` (the deliverable is a navigable deck, not a rendered video), and `/embedded-captions` and `/talking-head-recut` (the footage is untouched, so there's no storyboard to review).
|
|
|
|
In a hurry, skip the whole conversation by saying so:
|
|
|
|
> Just build it — don't ask me anything.
|
|
|
|
That locks `automation` with no storyboard wherever those apply, and every question the agent would have asked becomes a stated default in its heads-up instead.
|
|
|
|
Everything the interview settles is written to **`BRIEF.md`** in the project root — the brief is the artifact, not the chat. A later session (or a different agent) resumes from that file and asks nothing again; to change an answer, edit `BRIEF.md` rather than re-explaining yourself in the prompt.
|
|
|
|
## Recommended workflow
|
|
|
|
1. `npx hyperframes init my-video` — scaffold a project (skills install automatically)
|
|
2. Open the project in Claude Code (or Cursor / Codex)
|
|
3. Prompt with `/hyperframes` and one of the shapes above
|
|
4. `npx hyperframes preview` — watch in the browser as the agent edits
|
|
5. Iterate with small targeted prompts
|
|
6. `npx hyperframes lint && npx hyperframes check` — the gate: structure, runtime errors, layout collisions, motion, and contrast. Both must pass before you render
|
|
7. `npx hyperframes render --output final.mp4` when you're happy
|
|
|
|
`check` is the step people skip and regret. It runs the composition in a headless browser and reports what a still frame can't tell you — an element overflowing its region, two text blocks colliding, a runtime error that only fires mid-timeline, contrast below WCAG AA. It is fast and it is not optional: a render that took ten minutes will happily contain a defect `check` would have named in seconds.
|
|
|
|
|
|
|
|
## What a prompt buys you
|
|
|
|
Three prompts from this guide and their unedited renders — one workflow warm start, one registry-block piece, one dense freeform spec:
|
|
|
|
> /product-launch-video Make a 45-second 1920x1080 launch video for https://linear.app. Energetic but minimal, use the site's own palette and screenshots. Structure: hook stating the problem, 3 feature beats with UI captures and one-line captions, end card with logo + "Try it free". Female TTS voice, confident tone, subtle electronic BGM under -18dB.
|
|
|
|
<DocsVideo
|
|
title="HyperFrames video: Example Product Launch"
|
|
src="https://static.heygen.ai/hyperframes-oss/docs/images/prompting/example-product-launch-v2.mp4#t=0.1"
|
|
loop
|
|
/>
|
|
*Rendered from the prompt above, unedited.*
|
|
|
|
> /motion-graphics 6-second 1920x1080 video, dark navy background. Beat 1 (0-1s): label "ARR" fades up small, top-center. Beat 2 (1-4s): a giant number counts up to $4.2M with an odometer roll, easing out as it lands. Beat 3 (4-6s): "+312% YoY" stamps in below in green, then everything settles into a gentle ambient idle. Use the `apple-money-count` registry block as base. No narration.
|
|
|
|
<DocsVideo
|
|
title="HyperFrames video: Example Stat Countup"
|
|
src="https://static.heygen.ai/hyperframes-oss/docs/images/prompting/example-stat-countup.mp4#t=0.1"
|
|
loop
|
|
/>
|
|
*Rendered from the prompt above, unedited.*
|
|
|
|
And at the far end of the [specification dial](/prompting/specification-dial), a full visual+motion spec one-shots a broadcast-style animated globe — see [Recreating something you saw](/prompting/recreating-references) for the spec:
|
|
|
|
<DocsVideo
|
|
title="HyperFrames video: Recreate Globe Oneshot"
|
|
src="https://static.heygen.ai/hyperframes-oss/docs/images/prompting/recreate-globe-oneshot-v2.mp4#t=0.1"
|
|
loop
|
|
/>
|
|
*One-shot render from the distilled spec, no iteration.*
|
|
|
|
## Explore the guide
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Prompt anatomy" href="/prompting/anatomy">The six-part skeleton every one-shot prompt shares</Card>
|
|
<Card title="Verified examples" href="/prompting/examples">Copy-paste prompts, each one-shots a finished video</Card>
|
|
<Card title="The specification dial" href="/prompting/specification-dial">How much to specify, and what density buys</Card>
|
|
<Card title="Vocabulary" href="/prompting/vocabulary">Words that map to specific framework settings</Card>
|
|
<Card title="Premium motion" href="/prompting/motion">The eight-rule grammar that keeps video from feeling cheap</Card>
|
|
<Card title="Recreating references" href="/prompting/recreating-references">Match something you saw, from text alone</Card>
|
|
<Card title="Capstone" href="/prompting/capstone">The film above, dissected frame by frame</Card>
|
|
</CardGroup>
|
|
|
|
*Next: [Your first video](/prompting/product-launch) — one URL, one prompt, a finished launch video.*
|