Skip to content

Commit 061a5c0

Browse files
docs: add Studio app pages for Mac and Linux (#5063)
* docs: add Studio app pages for getting started with the Mac app Six short pages in a new Studio app tab: get the app, connect Claude Code or Codex, make your first video, change it with the agent, export, and updates and troubleshooting. Screenshots come from a neutral fixture project. * docs: cover Linux in the Studio app pages The app ships a Linux AppImage beside the Mac app. Install steps get Mac and Linux tabs, platform labels name both, and troubleshooting lists where projects, settings and exports live. * docs: correct Studio app sign-in, install and edit details First launch asks for HeyGen sign-in on the first click; the Mac download is a disk image with an installer inside; Select shows Prompt to edit; the Connect screen sends the waiting request itself; billing, export quality and update wording match the app. Open Terminal is described for both systems. * docs: keep Studio app tables readable on phones Three-column tables scrolled sideways at 390 px and the data-folder table broke paths mid-word; they become two-column tables and a short list. * docs: quote Studio app messages without their periods Quoted UI text no longer carries its own period into a sentence or table cell, and the Mac install step says the HeyGen check can take a minute or two. * docs: match Studio app installer and update messages Quote the installer's HeyGen check, damaged-download and slow-check messages, and the stalled-update messages with Download it instead and Settings' Download the latest version. * docs: fix Studio app sign-in timeout and Codex setup wording * docs: name Framey's stuck-update line in Studio app troubleshooting * docs: use one Studio app message per update state A stalled update says 'The update is taking longer than it should' and a failed one 'The update didn't finish', in Framey's line and on the card alike; Try again starts the update over. * docs: say Try again starts a new update, not one from zero
1 parent 9c7ff59 commit 061a5c0

11 files changed

Lines changed: 450 additions & 0 deletions

File tree

‎docs/docs.json‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,6 +248,33 @@
248248
}
249249
]
250250
},
251+
{
252+
"tab": "Studio app",
253+
"icon": "laptop",
254+
"groups": [
255+
{
256+
"group": "Get started",
257+
"pages": [
258+
"studio-app/index",
259+
"studio-app/connect-your-agent"
260+
]
261+
},
262+
{
263+
"group": "Make videos",
264+
"pages": [
265+
"studio-app/first-video",
266+
"studio-app/edit-with-the-agent",
267+
"studio-app/export"
268+
]
269+
},
270+
{
271+
"group": "Help",
272+
"pages": [
273+
"studio-app/troubleshooting"
274+
]
275+
}
276+
]
277+
},
251278
{
252279
"tab": "Catalog",
253280
"icon": "grid-2",
164 KB
Loading
120 KB
Loading
62.9 KB
Loading
158 KB
Loading
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: "Connect your agent"
3+
description: "Set up Claude Code or Codex once so the HyperFrames Studio app can build and change your videos."
4+
---
5+
6+
The app makes your videos with an agent that runs on your computer: **Claude Code** or **Codex**. You set one up
7+
once. After that, every request you send goes to it.
8+
9+
| Agent | You need |
10+
| --- | --- |
11+
| Claude Code | A Claude account or an Anthropic Console account. The app installs it for you. |
12+
| Codex | A ChatGPT account. You install it and sign in with two commands. |
13+
14+
Runs bill to the plan of the account your agent is signed in with. To use an API key instead, change **Bill runs
15+
to** in **Settings** > **Permissions**.
16+
17+
If both are ready and you have not picked one, the app uses Claude Code.
18+
19+
## Claude Code
20+
21+
The first time you send a request without an agent, the **Connect Claude Code** screen opens with three steps.
22+
23+
<Steps>
24+
<Step title="Install Claude Code">
25+
Choose **Install Claude Code**, then **Install** in the dialog. The app runs Anthropic's official installer,
26+
which puts Claude Code in your home folder. It takes about a minute.
27+
</Step>
28+
<Step title="Sign in">
29+
Choose **Sign in to Claude**. Your browser opens Claude's sign-in. Use your Claude account or an Anthropic Console
30+
account, then come back to the app.
31+
</Step>
32+
<Step title="Check that it answers">
33+
The app checks that Claude Code runs. When it shows **Claude Code is connected**, it sends the request you
34+
started with.
35+
</Step>
36+
</Steps>
37+
38+
If a step fails, the app shows a command you can run yourself. Choose **Copy command**, then **Open Terminal**, and
39+
paste it:
40+
41+
```bash
42+
# Install Claude Code
43+
curl -fsSL https://claude.ai/install.sh | bash
44+
45+
# Sign in
46+
claude auth login
47+
```
48+
49+
## Codex
50+
51+
The app does not install Codex for you. Open **Settings** > **Agent** or the agent picker in the chat header, find
52+
Codex, and use its buttons:
53+
54+
1. **Copy install command**, then paste it into a terminal:
55+
```bash
56+
curl -fsSL https://chatgpt.com/codex/install.sh | sh
57+
```
58+
2. **Copy sign-in command** (`codex`), run it in a terminal, and sign in with your ChatGPT account.
59+
3. Back in the app, choose **Check again**. Codex shows **Ready**.
60+
61+
## Switch agents
62+
63+
Use the agent picker in the chat header, or **Settings** > **Agent**, and choose **Use** next to the agent you want.
64+
The choice applies to your next request.
65+
66+
Each agent row shows its state: **Ready**, **Not signed in**, **Not installed**, or **Installed, but won't start**,
67+
with the button that fixes it.
68+
69+
## Related topics
70+
71+
- [Make your first video](/studio-app/first-video)
72+
- [Updates and troubleshooting](/studio-app/troubleshooting)
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
title: "Change your video with the agent"
3+
description: "Type a change, point at the picture, draw, or comment, then send several edits to the agent at once."
4+
---
5+
6+
Every change starts the same way: show the agent where, say what, and send. You can type, point at something in
7+
the picture, draw over it, or leave a comment at a moment in the video.
8+
9+
<Frame caption="A project: the chat on the left, the picture with its tools in the middle, and the timeline below.">
10+
<img
11+
src="/public/images/studio-app/project.jpg"
12+
alt="The Spring Launch project open in the HyperFrames Studio app with the chat, the picture, and the timeline"
13+
/>
14+
</Frame>
15+
16+
## Type a change
17+
18+
Type in the chat box, which says **Describe a change**, and press Enter. Type `@` to add moments, media, files, or
19+
other projects to your message.
20+
21+
While the agent is working, Enter queues your message to run next. To change that, open **Settings** > **Agent**
22+
and switch **While Framey works, Send** from **Queue** to **Steer**, which stops the run and starts again with your
23+
words. Picks and files always queue.
24+
25+
## Point, draw, or comment on the picture
26+
27+
The tools under the picture, on the left:
28+
29+
| Tool | What it does |
30+
| --- | --- |
31+
| **Select** (V) | Click an element, choose **Prompt to edit** (or press A), and describe the change. Click again to pick what contains it. |
32+
| **Draw** (D) | Circle or mark a spot and say what should change. Several strokes become one drawing. |
33+
| **Comment** (C) | Pin a comment to a spot and moment: **What should change here?** |
34+
35+
The picture opens with **Draw**. Press Escape to go back to **Select**. Right-click an element for quick actions
36+
such as **Ask Framey**, **Hide**, **Bring to front**, **Replace with**, and **Delete**.
37+
38+
You can also draw across the timeline to talk about a stretch of the video, such as "tighten this part".
39+
40+
## Send several edits at once
41+
42+
Picks, drawings, and comments do not run on their own. Each one becomes a row in **Pending video edits**, up to 10.
43+
Check them, add a note for all of them, then send them as one request with the send button, for example
44+
**Send 3 edits to Claude Code**. Choose **Edit note** to change a row's words, or **Delete** to drop it.
45+
46+
## Change the timeline yourself
47+
48+
Some changes are faster by hand. Hover a clip on the timeline to **Split** it at the playhead, **Delete** it, or
49+
open **Quick edit** to change a video or audio clip's **Speed**, **Volume**, and **Fade**. Drag clips to move or trim
50+
them.
51+
52+
Right-click an empty gap for **Close gap**, or to ask what should fill it. The app suggests ideas that fit what
53+
plays around the gap.
54+
55+
## Get inspired
56+
57+
**Get inspired** is a library of short example moments from real videos: **Motion graphics**, **A-roll Cuts**,
58+
and **Mobile Ads**. Find it on Home, in a new project's empty chat, and in the **Inspirations** tab beside your files.
59+
Choose **Add** or **Use** to put a moment in your message as a reference, then say how to use it and send.
60+
61+
## Undo
62+
63+
Press Cmd+Z to undo and Cmd+Shift+Z to redo (Ctrl+Z and Ctrl+Shift+Z on Linux). Each agent run in the chat also has its own **Undo** button.
64+
65+
## Related topics
66+
67+
- [Export and share](/studio-app/export)
68+
- [Make your first video](/studio-app/first-video)
69+
- [Updates and troubleshooting](/studio-app/troubleshooting)

‎docs/studio-app/export.mdx‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: "Export your video"
3+
description: "Render a finished video file from the HyperFrames Studio app and find it in your Downloads folder."
4+
---
5+
6+
When the video is ready, choose **Export** in the project's top bar. The **Export** panel opens beside the picture.
7+
8+
<Frame caption="The Export panel with quality, format, and frame rate.">
9+
<img
10+
src="/public/images/studio-app/export.jpg"
11+
alt="The Export panel in the HyperFrames Studio app with Quality, Format and Frame rate choices and a Render 1080p MP4 button"
12+
/>
13+
</Frame>
14+
15+
## Choose the file
16+
17+
| Choice | Options | Default |
18+
| --- | --- | --- |
19+
| **Quality** | **1080p** or **Project size**, plus **4K** when the project fits it | 1080p |
20+
| **Format** | **MP4**, **WebM**, **MOV** | MP4 |
21+
| **Frame rate** | 24, 30, 60 | 30 |
22+
23+
MP4 is the right choice for sharing and uploading. Pick another format only when the place you are sending it asks
24+
for one.
25+
26+
## Render
27+
28+
Choose the render button, for example **Render 1080p MP4**. The panel shows **Getting ready**, then **Rendering**
29+
with the frames done so far, then **Finishing the file**. You can close the panel and keep working; the render
30+
continues. Choose **Cancel** to stop it.
31+
32+
**Export** is unavailable while the agent is building the project. Wait for the run to finish.
33+
34+
## Find the file
35+
36+
The video is saved to your **Downloads** folder, named after the project with the date and time, for example
37+
`Spring Launch 2026-05-04 10.30.mp4`. When it is done, the panel shows **Export ready** with the file size:
38+
39+
- **Open video** plays it.
40+
- **Show in Finder** (**Show in folder** on Linux) opens the folder.
41+
42+
Watch the exported file once from start to end before you send it.
43+
44+
## If the export fails
45+
46+
- The render fails or does not start: choose the render button again. If it keeps failing,
47+
ask the agent to check the project, then export again.
48+
- **The video was made but could not be saved to your Downloads folder**: free up space or check that the Downloads
49+
folder exists, then export again.
50+
- **HyperFrames could not start its built-in FFmpeg**: the app may be damaged. Reinstall it from
51+
[hyperframes.dev/studio](https://hyperframes.dev/studio).
52+
53+
## Related topics
54+
55+
- [Change your video with the agent](/studio-app/edit-with-the-agent)
56+
- [Updates and troubleshooting](/studio-app/troubleshooting)

‎docs/studio-app/first-video.mdx‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
title: "Make your first video"
3+
description: "Pick four parts, add your website or idea, and let the agent build your first video in the HyperFrames Studio app."
4+
---
5+
6+
The **Create your first video** card on Home builds a launch video from four parts, each taken from a real launch
7+
video. You pick the parts, add your website or an idea, and the agent builds one video from them.
8+
9+
<Frame caption="The first-video card: four parts, then your website or idea.">
10+
<img
11+
src="/public/images/studio-app/first-video.jpg"
12+
alt="The Create your first video card with Hook, Proof, Turn and Call to action slots and a field for your website or idea"
13+
/>
14+
</Frame>
15+
16+
| Part | What it does |
17+
| --- | --- |
18+
| **Hook** | Grab attention in the first seconds |
19+
| **Proof** | Show the product doing its job |
20+
| **Turn** | Flip from problem to answer |
21+
| **Call to action** | Land the brand and the ask |
22+
23+
## Build it
24+
25+
<Steps>
26+
<Step title="Pick the four parts">
27+
The card starts with one clip in each part. Use the shuffle button beside them for a new set, or hover a part to
28+
shuffle it or browse the others.
29+
</Step>
30+
<Step title="Add your website or idea">
31+
Type your website, such as `yourcompany.com`, or describe your idea. A website gives the agent your fonts, colors
32+
and logo.
33+
</Step>
34+
<Step title="Choose Use this cut">
35+
The request goes straight to the agent. If you are not signed in or have no agent yet, the app walks you through
36+
that first, then sends it.
37+
</Step>
38+
</Steps>
39+
40+
## What should happen
41+
42+
The app creates a project for your video and the agent starts building it. On your first video, a short tour
43+
replays how a launch video was made while yours builds, then Framey takes you to your project. In the project, the
44+
chat shows what the agent is doing, such as **Reading files** or **Editing files**.
45+
46+
When the agent finishes, the video is ready to play, change, and export.
47+
48+
## Start from your own words instead
49+
50+
You do not need the card. Choose **Back to home**, type what you want in the prompt box, and press Enter. Type `@` to add files, other
51+
projects, or media. To open the card again later, choose **Take the step by step** next to **Get inspired**.
52+
53+
## Related topics
54+
55+
- [Change your video with the agent](/studio-app/edit-with-the-agent)
56+
- [Connect your agent](/studio-app/connect-your-agent)

‎docs/studio-app/index.mdx‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
title: "Get the HyperFrames Studio app"
3+
sidebarTitle: "Get the app"
4+
description: "Download the HyperFrames Studio app for Mac or Linux, open it for the first time, and sign in with your HeyGen account."
5+
---
6+
7+
The HyperFrames Studio app for Mac and Linux is the easiest way to make a video with HyperFrames. You describe the video, an
8+
agent on your computer builds it, and you change it by typing, pointing at the picture, drawing, or commenting.
9+
You do not need to write code. Framey, the small
10+
green guide, points you to the next step along the way.
11+
12+
<Frame caption="Home: the prompt box, your projects on the left, and Get inspired below.">
13+
<img
14+
src="/public/images/studio-app/home.jpg"
15+
alt="The HyperFrames Studio app's Home screen with the Make something prompt box and one project named Spring Launch"
16+
/>
17+
</Frame>
18+
19+
## Download and install
20+
21+
<Tabs>
22+
<Tab title="Mac">
23+
<Steps>
24+
<Step title="Download">
25+
Go to [hyperframes.dev/studio](https://hyperframes.dev/studio) and choose **Download for macOS**.
26+
</Step>
27+
<Step title="Install">
28+
Open the downloaded disk image and double-click **Install HyperFrames**. The installer copies the app into
29+
Applications and shows **Checking it is really from HeyGen**, which can take a minute or two. When it says
30+
**HyperFrames is in Applications**, choose **Open HyperFrames**.
31+
</Step>
32+
</Steps>
33+
34+
If your Mac's Applications folder is locked for your account, the installer puts the app in the Applications
35+
folder inside your home folder instead. If it says **The download looks damaged**, choose **Download again**. If
36+
it says the check **took too long**, nothing was installed: choose **Try again**.
37+
</Tab>
38+
<Tab title="Linux">
39+
<Steps>
40+
<Step title="Download">
41+
Go to [hyperframes.dev/studio](https://hyperframes.dev/studio) and choose **Download** next to Linux. You get
42+
one file, `HyperFrames-x86_64.AppImage`, for 64-bit Intel and AMD computers.
43+
</Step>
44+
<Step title="Make it runnable and open it">
45+
In a terminal, in the folder you downloaded it to:
46+
47+
```bash
48+
chmod +x HyperFrames-x86_64.AppImage
49+
./HyperFrames-x86_64.AppImage
50+
```
51+
</Step>
52+
</Steps>
53+
54+
The AppImage is the whole app. Keep it anywhere you like and open it the same way next time.
55+
</Tab>
56+
</Tabs>
57+
58+
## First launch
59+
60+
1. A short survey asks what you want to make and which agent you use. Every answer is optional, and **Skip all**
61+
counts as an answer. What you make decides where **Get inspired** opens. The agent you name starts your first
62+
chat if it is already set up.
63+
2. Home opens with the **Create your first video** card. See
64+
[Make your first video](/studio-app/first-video).
65+
66+
A notice also explains what usage data the app records. Choose **Got it** to dismiss it.
67+
68+
## Sign in with HeyGen
69+
70+
On first launch, the app asks you to sign in the first time you click something after the survey.
71+
72+
1. Choose **Continue with HeyGen**. Your browser opens hyperframes.dev.
73+
2. Sign in there within two minutes. The browser sends you back to the app, which shows **You're in!** and carries
74+
on with what you clicked.
75+
76+
If the sign-in runs out of time, choose **Continue with HeyGen** again. If you choose **Not now**, the app asks
77+
again on your next click.
78+
You can sign in or out at any time from **Settings** > **Account**.
79+
80+
## Related topics
81+
82+
- [Connect your agent](/studio-app/connect-your-agent)
83+
- [Make your first video](/studio-app/first-video)
84+
- [Updates and troubleshooting](/studio-app/troubleshooting)

0 commit comments

Comments
 (0)