> ## Documentation Index
> Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Install

> Install HeyGen Skills into Claude Code, Cursor, Codex, Gemini CLI, and 12+ other agents — via gh skill install, ClawHub, or git clone — then set up authentication.

The repo ships three skills you can install independently: **heygen-avatar**, **heygen-video**, and **heygen-translate**. Most users want avatar + video together (they chain); install translate whenever you need to localize finished videos.

> [!TIP]
>
> **Fastest path — let the agent do it.** Paste this into your agent and it handles everything (clone, auth, verify, first video):
>
> ```text theme={null}
> Read https://raw.githubusercontent.com/heygen-com/skills/master/INSTALL_FOR_AGENTS.md
> and follow it. Ask me for any API keys you need.
> ```

## Step 1 — Install the Skills

> [tab] gh skill install
>
> Works across 12+ agents (Claude Code, Cursor, Codex, Gemini CLI, Copilot, Junie, Goose, OpenHands, Amp, Cline, OpenCode, Warp, and more). Requires [GitHub CLI](https://cli.github.com) v2.90+. Writes to the correct directory for your agent automatically.
>
> ```bash theme={null}
> gh skill install heygen-com/skills heygen-avatar
> gh skill install heygen-com/skills heygen-video
> gh skill install heygen-com/skills heygen-translate
> ```
>
> Project scope is the default. For user scope (every project on this machine), add `--scope user`. Pin to a release tag for reproducibility:
>
> ```bash theme={null}
> gh skill install heygen-com/skills heygen-avatar@v3.1.0 --pin
> ```

> [tab] ClawHub
>
> Installs all three skills to your agent's default skills directory:
>
> ```bash theme={null}
> clawhub install heygen-skills
> ```

> [tab] OpenClaw plugin
>
> For OpenClaw users who want bundled MCP support:
>
> ```bash theme={null}
> openclaw plugins install clawhub:@heygen/openclaw-plugin-heygen
> ```

> [tab] Git clone
>
> Clone into your agent's skills directory. The three skills are auto-discovered at `heygen-avatar/SKILL.md`, `heygen-video/SKILL.md`, and `heygen-translate/SKILL.md`.
>
> ```bash theme={null}
> # Claude Code
> git clone https://github.com/heygen-com/skills.git ~/.claude/skills/heygen-skills
>
> # OpenClaw
> git clone https://github.com/heygen-com/skills.git ~/.openclaw/skills/heygen-skills
> ```
>
> Not sure where your skills directory is? Ask your agent: *"Where is your skills directory?"*

## Step 2 — Set Up Authentication

Pick the transport that matches how you want to be billed. The skills auto-detect which to use.

> [tab] CLI + API key (agents)
>
> Recommended for agents, CI, and scripts. Get a key at [platform.heygen.com/api-keys](https://platform.heygen.com/api-keys), then install the CLI and set the key:
>
> ```bash theme={null}
> curl -fsSL https://static.heygen.ai/cli/install.sh | bash
> export HEYGEN_API_KEY=<your-key>
> ```
>
> Verify:
>
> ```bash theme={null}
> heygen --version
> heygen auth status
> ```
>
> To persist the key across sessions, add the `export` line to your shell profile (`~/.zshrc`, `~/.bashrc`), or run `heygen auth login` to store it at `~/.heygen/credentials`. If `HEYGEN_API_KEY` is set, the skills use the CLI — no MCP probing.

> [tab] MCP + OAuth (no API key)
>
> Zero-setup if you're already on a HeyGen plan with credits. Connect the remote MCP server and the skills auto-detect it when no `HEYGEN_API_KEY` is set.
>
> ```bash theme={null}
> # Claude Code
> claude mcp add --transport http heygen https://mcp.heygen.com/mcp/v1/
> ```
>
> The first call triggers an OAuth consent flow in your browser. Calls run against your existing plan credits. See the [MCP setup guides](https://heygen-1fa696a7.mintlify.site/mcp/overview.md) for per-agent instructions.

> [!NOTE]
>
> **Priority:** If `HEYGEN_API_KEY` is set, the skills use the CLI. Otherwise they look for MCP tools. Set the key only if you want direct API access; otherwise use MCP. The skills require **v3 only** — never v1 or v2 endpoints.

## Step 3 — Create Your First Avatar and Video

With the skills installed and auth set, drive the full pipeline in two prompts:

**1. Create your avatar**

Use the **heygen-avatar** skill — from a description (default) or a photo:

```text theme={null}
Create my HeyGen avatar from this photo: [your photo]
```

The skill creates a persistent digital twin with a voice and saves an `AVATAR-<NAME>.md` file for reuse.

**2. Make a video**

Use the **heygen-video** skill — it picks up the avatar automatically:

```text theme={null}
Make a 30-60 second video of me introducing myself, casual tone.
```

The skill writes a script, runs the v3 Video Agent pipeline, and returns a share link.

**3. (Optional) Localize it**

Use the **heygen-translate** skill on any finished video:

```text theme={null}
Translate that video into Spanish and Japanese.
```

That's it — the avatar persists, so every future video reuses it automatically.

## Requirements

* A HeyGen account — sign in via MCP (OAuth) or with an [API key](https://platform.heygen.com/api-keys) for the CLI.
* An AI agent that supports skills (Claude Code, OpenClaw, Codex, Cursor, or similar).
* No runtime dependencies, packages, or build step.

> [card] [Full install reference](https://github.com/heygen-com/skills/blob/master/INSTALL.md)
>
> Pinning, scopes, and per-agent paths are documented in the repo's INSTALL.md.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.