Merge pull request #101 from heygen-com/fix/ftux-golden-path

feat(cli): improve FTUX to guide users toward AI agent workflow
This commit is contained in:
James Russo
2026-03-27 16:41:59 -07:00
committed by GitHub
4 changed files with 32 additions and 18 deletions
+6 -1
View File
@@ -18,7 +18,12 @@ Hyperframes is an open-source video rendering framework that lets you create, pr
```bash
npx hyperframes init my-video
cd my-video
npx hyperframes dev # preview in browser
```
Then open the project with your AI coding agent (Claude Code, Cursor, etc.) — it has HyperFrames skills installed and knows how to create and edit compositions.
```bash
npx hyperframes dev # preview in browser (live reload)
npx hyperframes render # render to MP4
```
+7 -5
View File
@@ -3,7 +3,7 @@ title: Quickstart
description: "Create, preview, and render your first Hyperframes video in under two minutes."
---
Go from zero to a rendered MP4 in four steps: scaffold a project, preview it live, customize the composition, and render.
Go from zero to a rendered MP4: scaffold a project, edit with your AI agent, preview live, and render.
## What you'll build
@@ -58,14 +58,14 @@ A 1920x1080 video with an animated title that fades in from above — rendered t
<Steps>
<Step title="Scaffold the project">
```bash
npx hyperframes init my-video --template blank
npx hyperframes init my-video
cd my-video
```
The CLI is non-interactive by default — pass `--template` to select a template. For interactive mode with prompts and menus, add `--human-friendly`:
This starts an interactive wizard that walks you through template selection and media import. To skip prompts (e.g. in CI or from an agent), use `--non-interactive`:
```bash
npx hyperframes init --human-friendly
npx hyperframes init my-video --non-interactive --template blank
```
See [Templates](/guides/templates) for all available templates.
@@ -113,7 +113,9 @@ A 1920x1080 video with an animated title that fades in from above — rendered t
</Step>
<Step title="Edit the composition">
Open `index.html` and replace it with this composition:
Open the project with your AI coding agent (Claude Code, Cursor, etc.) — HyperFrames skills are installed automatically and your agent knows how to create and edit compositions.
Or edit `index.html` directly — here's a minimal composition:
```html index.html
<div id="root" data-composition-id="my-video"
+3
View File
@@ -306,6 +306,9 @@ async function runEmbeddedMode(dir: string, startPort: number): Promise<void> {
console.log(` ${c.dim("Project")} ${c.accent(projectName)}`);
console.log(` ${c.dim("Studio")} ${c.accent(url)}`);
console.log();
console.log(` ${c.dim("Edit with your AI agent — it has HyperFrames skills installed.")}`);
console.log(` ${c.dim("Changes reload automatically in the studio.")}`);
console.log();
console.log(` ${c.dim("Press Ctrl+C to stop")}`);
console.log();
import("open").then((mod) => mod.default(`${url}#project/${projectName}`)).catch(() => {});
+16 -12
View File
@@ -646,23 +646,22 @@ Examples:
console.log(` ${c.accent(f)}`);
}
console.log();
console.log("Next steps:");
console.log("Get started:");
console.log();
console.log(` ${c.accent("1.")} Open this project with your AI coding agent:`);
console.log(
` ${c.accent(`cd ${name}`)} && ${c.accent("npx hyperframes dev")} ${c.dim("# preview in studio")}`,
` ${c.accent(`cd ${name}`)} then start ${c.accent("Claude Code")}, ${c.accent("Cursor")}, or your preferred agent`,
);
console.log(
` ${c.accent(`cd ${name}`)} && ${c.accent("npx hyperframes render")} ${c.dim("# render to MP4")}`,
);
console.log(
` ${c.accent("npx hyperframes docs")} ${c.dim("<topic>")} ${c.dim("# learn composition syntax")}`,
);
console.log(
` ${c.dim("topics: data-attributes, gsap, compositions, rendering, templates, troubleshooting")}`,
` ${c.dim("AI skills are installed — your agent knows how to create and edit compositions.")}`,
);
console.log();
console.log(
` ${c.dim("AI skills installed — open this folder in your AI coding agent to get started.")}`,
);
console.log(` ${c.accent("2.")} Preview in the browser:`);
console.log(` ${c.accent(`cd ${name}`)} && ${c.accent("npx hyperframes dev")}`);
console.log();
console.log(` ${c.accent("3.")} Render to MP4 when ready:`);
console.log(` ${c.accent(`cd ${name}`)} && ${c.accent("npx hyperframes render")}`);
console.log();
console.log(` ${c.dim("Full docs: hyperframes.heygen.com")}`);
return;
}
@@ -860,6 +859,11 @@ Examples:
const files = readdirSync(destDir);
clack.note(files.map((f) => c.accent(f)).join("\n"), c.success(`Created ${name}/`));
clack.log.message(
`${c.dim("Tip:")} Open this project with ${c.accent("Claude Code")}, ${c.accent("Cursor")}, or your preferred AI agent.\n` +
`${c.dim(" AI skills are installed — your agent knows how to create and edit compositions.")}`,
);
await nextStepLoop(destDir);
},
});