Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
"group": "Start here",
"pages": [
"introduction",
"guides/is-hyperframes-free",
"quickstart",
"go-further",
"developers/index"
Expand All @@ -74,6 +75,9 @@
"group": "Choose where to create",
"pages": [
"guides/choose-creation-path",
"guides/with-claude-code",
"guides/with-codex",
"guides/with-cursor",
"guides/mcp",
"guides/design-tools"
]
Expand Down Expand Up @@ -169,7 +173,8 @@
"guides/music-to-video",
"guides/slideshow",
"guides/general-video",
"guides/hyperframes-vs-remotion"
"guides/hyperframes-vs-remotion",
"guides/remotion-alternatives"
]
},
{
Expand All @@ -190,6 +195,7 @@
"group": "Help",
"pages": [
"help",
"faq",
"guides/troubleshooting",
"guides/feedback"
]
Expand Down
155 changes: 155 additions & 0 deletions docs/faq.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
---
title: "HyperFrames FAQ"
sidebarTitle: "FAQ"
description: "Short answers to the questions people ask most about HyperFrames: cost, which agent to use, Windows, Studio, Remotion, rendering, audio, and fonts."
---

Short answers to the questions people ask the docs assistant most often. Each
answer links to the page with the details.

## Is HyperFrames free?

Yes. The framework, CLI, and skills are open source under Apache 2.0, and
rendering on your own computer is free and needs no account. Your AI agent's
plan and optional HeyGen-hosted features, such as HeyGen voices, avatars, and
cloud rendering, bill through their own accounts. See
[Is HyperFrames free?](/guides/is-hyperframes-free).

## Can I use HyperFrames commercially?

Yes. The [Apache 2.0 license](https://github.com/heygen-com/hyperframes/blob/main/LICENSE)
lets you use, change, and distribute HyperFrames, including in commercial work,
under its terms. Media you add, such as fonts, music, or footage, keeps its own
license.

## Which AI agent should I use?

Any coding agent that supports skills works, including Claude Code, Codex,
Cursor, Gemini CLI, GitHub Copilot, Google Antigravity, IBM Bob, and OpenCode.
If you have none yet, start with Claude Code or Codex. Setup guides:
[Claude Code](/guides/with-claude-code), [Codex](/guides/with-codex),
[Cursor](/guides/with-cursor), and [other agents](/guides/skills).

## Can I use it in the Claude or ChatGPT chat app?

Yes, through the hosted HyperFrames connector. It creates and renders videos in
your HeyGen account, with nothing installed on your computer. You give up the
local project folder and Studio. Your chat product's plan decides whether you
can add a custom connector. See [Create through an AI chat](/guides/mcp).

## How do I install it?

For Claude Code, install the plugin:

```bash
claude plugin marketplace add heygen-com/hyperframes
claude plugin install hyperframes@hyperframes
```

For most other agents, run `npx skills add heygen-com/hyperframes` and choose
**Core Skills**. Then start a new agent session. See
[Make your first video](/quickstart).

## Do I need a HeyGen account or API key?

Not to make and render videos on your computer. You need one for HeyGen voices
and music, avatars, cloud rendering, the hosted connector, and the Studio app.
Sign in with `npx hyperframes auth login`. See
[Authentication and API keys](/guides/authentication).

## Does HyperFrames work on Windows?

The CLI and the agent skills run on Windows, including rendering from
PowerShell. The HyperFrames Studio app is available for Mac and Linux only. On
Windows, edit in Studio in the browser with `npx hyperframes preview`. For WSL
rendering tips, see [Troubleshooting](/guides/troubleshooting).

## What is the difference between Studio and the Studio app?

The **Studio app** is a desktop app for Mac and Linux: a chat with your agent, a
preview, and an editor in one window, with no terminal needed. **Studio in the
browser** is the editor that opens from any project when you run
`npx hyperframes preview`. Both edit the same project files. See
[Get the Studio app](/studio-app) and
[Work on a project in Studio](/studio).

## How is HyperFrames different from Remotion?

Remotion videos are React components. HyperFrames videos are HTML, CSS, and
JavaScript, timed with data attributes and a paused animation timeline.
HyperFrames does not use or run Remotion. See
[HyperFrames or Remotion?](/guides/hyperframes-vs-remotion) and
[Remotion alternatives](/guides/remotion-alternatives).

## How do I preview and render a video?

Inside the project folder, open the live preview:

```bash
npx hyperframes preview
```

Then render the MP4:

```bash
npx hyperframes render --output final.mp4
```

Rendering needs FFmpeg. Run `npx hyperframes doctor` to check your machine. See
[Render from the command line](/guides/rendering).

## How long does a render take?

It depends on length, resolution, and effects. In one measured example, a
300-frame 1920×1080 composition rendered in 9.8 seconds, and in 25 seconds with
one expensive CSS declaration left in. Use `--quality draft` for a faster review
render. See [Fix a slow preview or render](/guides/performance).

## Can it add voiceover, music, and sound effects?

Yes. Ask the agent for them in your request. With a HeyGen account it uses HeyGen
voices and the HeyGen music library. Without one, voice uses Kokoro, music uses
MusicGen, and sound effects come from a bundled library, all on your computer.
See [Use voice, music, sound, and captions](/guides/voice-and-audio).

## Can it add captions to my video?

Yes. Give the agent your talking-head footage and ask for captions. It
transcribes the speech, times each word, and adds captions without changing the
footage. See [Add captions or repackage talking-head footage](/guides/captions-and-recuts).

## Can I use my own fonts?

Yes. Put the font file in the project and declare it with `@font-face`. A font
the project does not declare can fall back to a default face in the render, and
`npx hyperframes lint` reports it. See the
[font lint rules](/reference/lint-rules#fonts).

## Can I render in the cloud or on my own servers?

Yes. `hyperframes cloud render` renders on HeyGen's cloud and bills credits to
your HeyGen account. You can also render on your own AWS Lambda or Google Cloud
Run, or in Docker. See [Choose a rendering path](/deploy/overview).

## Does HyperFrames send my video to HeyGen?

Not when you preview and render locally: the project stays on your computer.
Cloud rendering uploads the project to HeyGen, and the hosted connector builds it
in your HeyGen account. The CLI sends usage data, such as command names and
render performance, which stays anonymous until you sign in. It never sends
project names or video content. Turn it off with `npx hyperframes telemetry disable`. Your
AI agent sends your prompts to its own provider. See
[the telemetry reference](/packages/cli#telemetry).

## Something failed. What do I check first?

Run these in the project folder and give the agent the full output:

```bash
npx hyperframes doctor
npx hyperframes lint
npx hyperframes check
```

See [Troubleshooting](/guides/troubleshooting) for specific errors, and
[Share feedback](/guides/feedback) to report a bug.
1 change: 1 addition & 0 deletions docs/guides/hyperframes-vs-remotion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -163,3 +163,4 @@ because one framework looks newer.
- [How a HyperFrames composition works](/concepts/compositions)
- [Install and use the agent skills](/guides/skills)
- [Choose a rendering path](/deploy/overview)
- [Compare more Remotion alternatives](/guides/remotion-alternatives)
60 changes: 60 additions & 0 deletions docs/guides/is-hyperframes-free.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: "Is HyperFrames free?"
sidebarTitle: "Is it free?"
description: "Yes. HyperFrames is open source under Apache 2.0 and renders locally for free. See what can cost money, and who bills you for it."
---

Yes. The HyperFrames framework, CLI, and agent skills are open source under the
[Apache 2.0 license](https://github.com/heygen-com/hyperframes/blob/main/LICENSE),
and rendering on your own computer is free. You pay only for the services you choose to add, such as
your AI agent's plan or HeyGen-hosted features.

## What is free

| Part | Cost |
| --- | --- |
| The framework, CLI, and skills | Free and open source (Apache 2.0). You can use, change, and ship them, including in commercial work, under the license terms. |
| Preview and render on your computer | Free. Local rendering does not use HeyGen credits and does not need an account. |
| Offline voice, music, and sound effects | Free. With no key set, voice uses Kokoro, music uses MusicGen, and sound effects come from a bundled library. See [Working offline](/guides/authentication#working-offline). |
| The HyperFrames Studio app | Free to download for Mac and Linux. You do not need to sign in to download it. |
| Studio in the browser | Free. It opens from any project with `npx hyperframes preview`. |

## What can cost money

None of these come from HyperFrames itself. Each one bills through its own account.

| You use | Who bills you |
| --- | --- |
| An AI agent (Claude Code, Codex, Cursor, and others) | The agent's provider, on your own plan or API key. In the Studio app, runs bill to the plan of the account your agent is signed in with. See [Connect your agent](/studio-app/connect-your-agent). |
| HeyGen voices, the HeyGen music library, and avatar presenters | Your HeyGen account. Some of these draw on the account's allowance or credits. |
| Cloud rendering with `hyperframes cloud render` | Your HeyGen account, in credits. 4K renders bill at 1.5×. See [Cloud rendering](/deploy/cloud). |
| The hosted HyperFrames connector in an AI chat | Your HeyGen account and the chat product's plan. See [Create through an AI chat](/guides/mcp). |
| Rendering on your own AWS Lambda or Google Cloud Run | Your cloud provider. See [AWS Lambda](/deploy/aws-lambda) and [Google Cloud Run](/deploy/gcp-cloud-run). |
| Other providers you add a key for, such as ElevenLabs or Gemini | That provider. See [Providers used by agent workflows](/guides/authentication#providers-used-by-agent-workflows). |

Check your HeyGen account's usage before a long or repeated run that uses hosted
features.

## Do I need a HeyGen account?

Not to make and render videos on your computer. You need one for HeyGen-hosted
features, cloud rendering, the hosted connector, and the Studio app, which asks
you to sign in on first launch. Signing in and creating an account are the same
step:

```bash
npx hyperframes auth login
```

See [Authentication and API keys](/guides/authentication).

## Related topics

<CardGroup cols={2}>
<Card title="Make your first video" icon="play" href="/quickstart">
Install the skills and make a video locally, for free.
</Card>
<Card title="HyperFrames FAQ" icon="circle-question" href="/faq">
Answers to the questions people ask most.
</Card>
</CardGroup>
51 changes: 51 additions & 0 deletions docs/guides/remotion-alternatives.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: "Remotion alternatives"
description: "Compare tools that make video from code: HyperFrames, Remotion, Motion Canvas, Revideo, Editframe, Shotstack, and Creatomate. What you write, cost, and fit."
---

The main alternatives to Remotion are HyperFrames (HTML), Motion Canvas and
Revideo (TypeScript), Editframe (HTML or React), and the hosted APIs Shotstack
and Creatomate (JSON templates). Pick by what you want to write and where you
want the render to run.

## At a glance

| Tool | What you write | License and pricing, in plain words | Best for |
| --- | --- | --- | --- |
| [HyperFrames](https://github.com/heygen-com/hyperframes) | HTML, CSS, and JavaScript, often written by an AI agent | Open source, [Apache 2.0](https://github.com/heygen-com/hyperframes/blob/main/LICENSE). Local rendering is free; optional [cloud rendering](/deploy/cloud) uses HeyGen credits | Agent-made videos, and teams with existing HTML, CSS, GSAP, or Lottie work |
| [Remotion](https://www.remotion.dev) | React components | Free for individuals and companies of up to three people; a paid company license is required for four or more ([terms](https://www.remotion.pro/license)) | React teams that want typed components and a mature ecosystem |
| [Motion Canvas](https://motioncanvas.io) | TypeScript generator functions, with an editor for a live preview | Open source, [MIT](https://github.com/motion-canvas/motion-canvas) | Informative vector animations synced to a voiceover |
| [Revideo](https://github.com/redotvideo/revideo) | TypeScript scenes as generator functions, plus a render API and a React player | Open source, [MIT](https://github.com/redotvideo/revideo) | Code-defined scenes rendered from your own app or service |
| [Editframe](https://www.editframe.com) | HTML and CSS custom elements, or React | Free for individuals and teams of up to three; paid plans for larger organizations and for metered cloud rendering ([pricing](https://www.editframe.com/pricing)) | Personalized video from app data, and an editor embedded in your product |
| [Shotstack](https://shotstack.io) | JSON edits and templates, sent to a cloud API (SDKs for Node.js, Python, PHP, and Ruby) | Hosted service. Free sandbox; you pay per rendered minute with credits, pay as you go or monthly ([pricing](https://shotstack.io/pricing/)) | High-volume templated rendering with no render servers to run |
| [Creatomate](https://creatomate.com) | Templates made in an online editor, filled through a REST API, or JSON | Hosted service. Free trial; monthly plans with credits, where video cost depends on resolution, frame rate, and length ([pricing](https://creatomate.com/pricing)) | Automated social and marketing videos, including no-code workflows |

Pricing and terms change. Check each linked page before you decide.

## How to choose

- **You want an AI agent to make the video.** HyperFrames ships agent skills
that plan, build, check, and render a project. See
[Make your first video](/quickstart).
- **Your team writes React.** Remotion or Editframe keep you in components.
For the line-by-line difference from HyperFrames, see
[HyperFrames or Remotion?](/guides/hyperframes-vs-remotion).
- **You animate diagrams or explainers by hand in code.** Motion Canvas and
Revideo are built around generator-function scenes.
- **You fill the same template thousands of times and do not want servers.**
Shotstack and Creatomate render in their cloud from JSON or templates.
HyperFrames can do this with [template variables](/concepts/variables) and
[cloud rendering](/deploy/cloud) or your own
[AWS Lambda](/deploy/aws-lambda).

## Moving from Remotion

HyperFrames does not run Remotion code. To port an existing Remotion
composition, ask your agent to use the `remotion-to-hyperframes` skill. See
[Porting from Remotion](/prompting/remotion-migration).

## Related topics

- [HyperFrames or Remotion?](/guides/hyperframes-vs-remotion)
- [Is HyperFrames free?](/guides/is-hyperframes-free)
- [HyperFrames FAQ](/faq)
Loading
Loading