Local environment
Installation guide
Install MkBoard Desktop and prepare the local Agent and video rendering environment.
Installation Guide
Prepare the environment in this order. After each step, return to MkBoard's local CLI settings page and click the top-level "Rescan" button.
1. Download
Choose the installer that matches your device, then download and install MkBoard Desktop. After opening MkBoard, go to the local CLI settings page.
2. Configure Agent
MkBoard uses a local Agent on your computer to read the current project and run storyboard splitting, repair, and generation tasks. MkBoard currently supports Codex CLI and Claude Code. Make sure you install the CLI version; installing only the desktop app or editor extension may not be enough for MkBoard detection.
Install and sign in to one local Agent first:
- Codex CLI: follow the official OpenAI setup guide to install the CLI and sign in.
- Claude Code CLI: follow the official Claude Code quickstart to install the CLI and sign in.
After installation, finish sign-in or configuration in your terminal and make sure Codex CLI or Claude Code CLI runs correctly.
3. Install Hyperframes
Run this command in your terminal:
npx skills add heygen-com/hyperframes
Installing Hyperframes requires FFmpeg and Node.js. If you are not sure how to install those dependencies, ask your configured Claude Code or Codex CLI to check and install them for you.
4. Start using MkBoard
After the setup is complete, open MkBoard Desktop and create a project. You can write your script, organize the storyboard, and continue into video drafts.
Need Help
If setup fails, join the Feishu group. We will help you finish the environment configuration.
