Skip to content

Commit 5bb9431

Browse files
authored
docs(guides): pages for making videos with Claude Code, Codex and Cursor (#6352)
1 parent 33685ef commit 5bb9431

7 files changed

Lines changed: 326 additions & 2 deletions

File tree

‎docs/docs.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,14 @@
7474
"group": "Choose where to create",
7575
"pages": [
7676
"guides/choose-creation-path",
77+
{
78+
"group": "With your agent",
79+
"pages": [
80+
"guides/with-claude-code",
81+
"guides/with-codex",
82+
"guides/with-cursor"
83+
]
84+
},
7785
"guides/mcp",
7886
"guides/design-tools"
7987
]

‎docs/guides/choose-creation-path.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ Using /hyperframes, make a 10-second product intro for https://example.com.
3535

3636
[Make your first video with your agent →](/quickstart#with-your-agent)
3737

38+
Step by step: [Claude Code](/guides/with-claude-code), [Codex](/guides/with-codex), [Cursor](/guides/with-cursor).
39+
3840
## Start in an AI chat if you want nothing installed
3941

4042
The hosted HyperFrames connector (an MCP connector — a plug-in an AI chat can

‎docs/guides/with-claude-code.mdx‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
title: "Make videos with Claude Code"
3+
sidebarTitle: "Claude Code"
4+
description: "Install the HyperFrames plugin in Claude Code, ask for a video in plain words, then preview and render it to MP4 on your computer."
5+
---
6+
7+
Install the HyperFrames plugin, then ask Claude Code for a video. Claude Code
8+
writes an HTML project in your folder, opens a live preview, and renders the MP4
9+
on your computer.
10+
11+
```bash
12+
claude plugin marketplace add heygen-com/hyperframes
13+
claude plugin install hyperframes@hyperframes
14+
```
15+
16+
## Before you start
17+
18+
- [Claude Code](https://code.claude.com/docs), signed in with your Claude account
19+
or an Anthropic Console account. Its usage bills to that account.
20+
- Node.js 22 or newer, and npm.
21+
- FFmpeg, for rendering MP4 files. Run `npx hyperframes doctor` to check.
22+
23+
## Install
24+
25+
<Tabs>
26+
<Tab title="Plugin (recommended)">
27+
Run the two commands above in your terminal. Then start a new Claude Code
28+
session, or run `/reload-plugins` in the current one.
29+
30+
To get updates on their own, run `/plugin`, open **Marketplaces**, select
31+
**hyperframes**, and choose **Enable auto-update**. See
32+
[Install the HyperFrames plugin](/guides/plugins#claude-code) for manual updates and
33+
removal.
34+
</Tab>
35+
<Tab title="Standalone skills">
36+
Run this in your project folder and choose **Core Skills**:
37+
38+
```bash
39+
npx skills add heygen-com/hyperframes
40+
```
41+
42+
Or install the core set for your user, with no picker:
43+
44+
```bash
45+
npx hyperframes skills update
46+
```
47+
48+
Start a new Claude Code session afterwards. See
49+
[Install and update agent skills](/guides/skills).
50+
</Tab>
51+
</Tabs>
52+
53+
## Ask for your first video
54+
55+
Open Claude Code in an empty folder and paste:
56+
57+
```text
58+
Using /hyperframes:hyperframes, make a 10-second product intro for https://example.com.
59+
```
60+
61+
With standalone skills, the skill is `/hyperframes` instead of
62+
`/hyperframes:hyperframes`. Replace the URL with the page you want the video to
63+
show.
64+
65+
## What happens
66+
67+
1. Claude Code reads the HyperFrames guide for your kind of video, such as a product
68+
launch or an explainer, and builds the project in your folder. For a longer
69+
film that tells a story, it first offers three storylines to pick from.
70+
2. It checks the project and opens a local preview.
71+
72+
Watch the first version and say what to change, in the same conversation.
73+
74+
## Preview and render
75+
76+
To reopen the preview later, run this inside the project folder:
77+
78+
```bash
79+
npx hyperframes preview
80+
```
81+
82+
The preview opens in the browser editor, where you can also edit the video by
83+
hand. To make the MP4 yourself:
84+
85+
```bash
86+
npx hyperframes render --output final.mp4
87+
```
88+
89+
You can also ask Claude Code to render it.
90+
91+
## Prefer an app?
92+
93+
The [HyperFrames Studio app](/studio-app) for Mac and Linux can use Claude Code
94+
as its agent. It installs Claude Code for you and gives you a chat, a preview,
95+
and an editor in one window. To create inside the Claude chat app instead, with
96+
nothing installed, use the [hosted connector](/guides/mcp).
97+
98+
## If something goes wrong
99+
100+
- **Claude Code does not see the skill.** Start a new session or run
101+
`/reload-plugins`. For standalone skills, run `npx hyperframes skills check`.
102+
- **The render fails.** Run `npx hyperframes doctor` and fix what it reports.
103+
- **Anything else.** See [Troubleshooting](/help).
104+
105+
## Related topics
106+
107+
- [Make your first video](/quickstart)
108+
- [Choose what to make](/workflows)
109+
- [Write better prompts](/prompting/overview)

‎docs/guides/with-codex.mdx‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
title: "Make videos with Codex"
3+
sidebarTitle: "Codex"
4+
description: "Install the HyperFrames skills for OpenAI Codex, ask for a video in plain words, then preview and render it to MP4 on your computer."
5+
---
6+
7+
Install the HyperFrames skills, then ask Codex for a video. Codex writes an HTML
8+
project in your folder, opens a live preview, and renders the MP4 on your
9+
computer.
10+
11+
```bash
12+
npx hyperframes skills update
13+
```
14+
15+
This installs the core skills into your user's shared skills folder,
16+
`~/.agents/skills`, which Codex reads in every project.
17+
18+
## Before you start
19+
20+
- [Codex](https://developers.openai.com/codex), signed in with your ChatGPT
21+
account or an OpenAI API key. Its usage bills to that account.
22+
- Node.js 22 or newer, and npm.
23+
- FFmpeg, for rendering MP4 files. Run `npx hyperframes doctor` to check.
24+
25+
## Install
26+
27+
Run the command above once. Run it again later to update the skills.
28+
29+
To keep the skills with one project instead, run this in the project folder and
30+
choose **Core Skills** and **Codex** in the picker:
31+
32+
```bash
33+
npx skills add heygen-com/hyperframes
34+
```
35+
36+
Start a new Codex session after either install. See
37+
[Install and update agent skills](/guides/skills) for checking and updating.
38+
39+
## Ask for your first video
40+
41+
Open Codex in an empty folder and paste:
42+
43+
```text
44+
Use $hyperframes to make a 10-second product intro for https://example.com.
45+
```
46+
47+
`$hyperframes` names the HyperFrames skill. Replace the URL with the page
48+
you want the video to show.
49+
50+
## What happens
51+
52+
1. Codex reads the HyperFrames guide for your kind of video, such as a product
53+
launch or an explainer, and builds the project in your folder. For a longer
54+
film that tells a story, it first offers three storylines to pick from.
55+
2. It checks the project and opens a local preview.
56+
57+
Codex may ask before it runs a command or uses the network. The skills install
58+
packages, start a preview server, and run the renderer, so approve those steps
59+
for this folder. Watch the first version and say what to change, in the same
60+
conversation.
61+
62+
## Preview and render
63+
64+
To reopen the preview later, run this inside the project folder:
65+
66+
```bash
67+
npx hyperframes preview
68+
```
69+
70+
The preview opens in the browser editor, where you can also edit the video by
71+
hand. To make the MP4 yourself:
72+
73+
```bash
74+
npx hyperframes render --output final.mp4
75+
```
76+
77+
You can also ask Codex to render it.
78+
79+
## Prefer an app?
80+
81+
The [HyperFrames Studio app](/studio-app) for Mac and Linux can use Codex as its
82+
agent. See [Connect your agent](/studio-app/connect-your-agent). To create
83+
inside ChatGPT instead, with nothing installed, use the
84+
[hosted connector](/guides/mcp).
85+
86+
## If something goes wrong
87+
88+
- **Codex does not see the skill.** Start a new session, then run
89+
`npx hyperframes skills check`.
90+
- **The render fails.** Run `npx hyperframes doctor` and fix what it reports.
91+
- **Anything else.** See [Troubleshooting](/help).
92+
93+
## Related topics
94+
95+
- [Make your first video](/quickstart)
96+
- [Choose what to make](/workflows)
97+
- [Write better prompts](/prompting/overview)

‎docs/guides/with-cursor.mdx‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
title: "Make videos with Cursor"
3+
sidebarTitle: "Cursor"
4+
description: "Install the HyperFrames skills in Cursor, ask its agent for a video in plain words, then preview and render it to MP4 on your computer."
5+
---
6+
7+
Install the HyperFrames skills in your project, then ask Cursor's agent for a
8+
video. The agent writes an HTML project in your folder, opens a live preview,
9+
and renders the MP4 on your computer.
10+
11+
```bash
12+
npx skills add heygen-com/hyperframes
13+
```
14+
15+
Run it in the root of the folder you open in Cursor, and choose **Core Skills**
16+
and **Cursor** in the picker.
17+
18+
## Before you start
19+
20+
- [Cursor](https://cursor.com), signed in. Agent usage bills to your Cursor plan.
21+
- Node.js 22 or newer, and npm.
22+
- FFmpeg, for rendering MP4 files. Run `npx hyperframes doctor` to check.
23+
24+
## Install
25+
26+
<Tabs>
27+
<Tab title="Project skills">
28+
Run the command above in the project folder. The skills stay with that
29+
project. Reload Cursor or start a new agent chat afterwards.
30+
</Tab>
31+
<Tab title="For your user">
32+
Install the core set once for every project:
33+
34+
```bash
35+
npx hyperframes skills update
36+
```
37+
38+
When Cursor is installed, this links the skills into `~/.cursor/skills`.
39+
Run it again later to update them.
40+
</Tab>
41+
<Tab title="Plugin">
42+
Teams can add the HyperFrames plugin through a Cursor team marketplace, or
43+
load a local copy. See [Install the HyperFrames plugin](/guides/plugins#cursor).
44+
</Tab>
45+
</Tabs>
46+
47+
## Ask for your first video
48+
49+
Open a new agent chat in an empty project and paste:
50+
51+
```text
52+
Using /hyperframes, make a 10-second product intro for https://example.com.
53+
```
54+
55+
Replace the URL with the page you want the video to show.
56+
57+
## What happens
58+
59+
1. The agent reads the HyperFrames guide for your kind of video, such as a product
60+
launch or an explainer, and builds the project in your folder. For a longer
61+
film that tells a story, it first offers three storylines to pick from.
62+
2. It checks the project and opens a local preview.
63+
64+
The agent runs terminal commands to install packages, start the preview, and
65+
render. Approve them when Cursor asks. Watch the first version and say what to
66+
change, in the same chat.
67+
68+
## Preview and render
69+
70+
To reopen the preview later, run this in Cursor's terminal, inside the project
71+
folder:
72+
73+
```bash
74+
npx hyperframes preview
75+
```
76+
77+
The preview opens in the browser editor, where you can also edit the video by
78+
hand. To make the MP4 yourself:
79+
80+
```bash
81+
npx hyperframes render --output final.mp4
82+
```
83+
84+
You can also ask the agent to render it.
85+
86+
## Prefer an app?
87+
88+
The [HyperFrames Studio app](/studio-app) for Mac and Linux gives you a chat, a
89+
preview, and an editor in one window. It runs Claude Code, Codex, and other
90+
agents, but not Cursor. See [Connect your agent](/studio-app/connect-your-agent).
91+
92+
## If something goes wrong
93+
94+
- **The agent does not see the skill.** Start a new agent chat. Confirm that
95+
`.agents/skills` (project install) or `~/.cursor/skills` (user install)
96+
contains `hyperframes`, then run `npx hyperframes skills check`.
97+
- **The render fails.** Run `npx hyperframes doctor` and fix what it reports.
98+
- **Anything else.** See [Troubleshooting](/help).
99+
100+
## Related topics
101+
102+
- [Make your first video](/quickstart)
103+
- [Choose what to make](/workflows)
104+
- [Write better prompts](/prompting/overview)

‎docs/quickstart.mdx‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,9 @@ Set this folder up for HyperFrames and make me a video.
6565

6666
<Steps>
6767
<Step title="Install the plugin or skills">
68+
Step-by-step pages: [Claude Code](/guides/with-claude-code), [Codex](/guides/with-codex),
69+
[Cursor](/guides/with-cursor).
70+
6871
For Claude Code, Copilot, VS Code, Cursor, or Gemini CLI, start with the
6972
[plugin installation guide](/guides/plugins). It includes update settings for each agent. Claude's plugin entry
7073
skill is `/hyperframes:hyperframes`.
@@ -81,8 +84,8 @@ Set this folder up for HyperFrames and make me a video.
8184
Using /hyperframes, make a 10-second product intro for https://example.com.
8285
```
8386

84-
Replace `https://example.com` with the page you want the video to show. The agent proposes a direction and asks
85-
for anything important that is missing.
87+
Replace `https://example.com` with the page you want the video to show. For a longer film that tells a story, the
88+
agent first offers three storylines to pick from.
8689
</Step>
8790
<Step title="Continue from the first version">
8891
The agent leaves you with a project folder and opens its preview in the browser editor. To reopen it later, run

‎docs/studio-app/connect-your-agent.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,4 @@ fixes it.
7272

7373
- [Make your first video](/studio-app/first-video)
7474
- [Troubleshooting](/studio-app/troubleshooting)
75+
- Use your agent outside the app: [Claude Code](/guides/with-claude-code), [Codex](/guides/with-codex), [Cursor](/guides/with-cursor)

0 commit comments

Comments
 (0)