MkBoard Environment Setup

Introduction

MkBoard’s local environment has two parts:

• Local Agent: choose either Codex CLI or Claude Code. MkBoard uses it to read the current script, storyboard table, and project assets.
• Video rendering: based on HyperFrames, which requires Node.js 22+ and FFmpeg on your machine.

MkBoard does not store credentials for Codex, Claude Code, or HyperFrames. It only reuses CLI sessions already available locally. See the setup notes below.

Official Sources

Tool	Official source	MkBoard use
Codex CLI	OpenAI Codex CLI / openai/codex GitHub	Local Agent
Claude Code	Claude Code setup / Claude Code authentication	Local Agent
Node.js	Node.js downloads	HyperFrames runtime
FFmpeg	FFmpeg Download / Homebrew ffmpeg	HyperFrames video encoding
HyperFrames	HyperFrames Quickstart / heygen-com/hyperframes GitHub	HTML video rendering

Setup

Use the official docs for installation. This page keeps only the official entry points and the checks MkBoard relies on.

Codex CLI

Codex CLI can act as MkBoard’s local Agent. Install and sign in from OpenAI Codex CLI or openai/codex GitHub.

codex login status

MkBoard uses codex login status to confirm the local Codex session. If browser login fails, follow the official device auth instructions.

Claude Code

Claude Code can also act as MkBoard’s local Agent. Install and authenticate from Claude Code setup and Claude Code authentication.

claude auth status --json

MkBoard uses claude auth status --json to confirm the local Claude Code session. After signing in, reopen your terminal and click “Rescan” in MkBoard.

Node.js 22+

HyperFrames requires Node.js 22 or newer. Install it from Node.js downloads.

node --version

If the version is lower than v22, upgrade Node.js and reopen your terminal.

FFmpeg

FFmpeg must be executable from your system terminal. Install it from FFmpeg Download. On macOS with Homebrew, you can also use the Homebrew ffmpeg formula.

ffmpeg -version

If MkBoard still cannot find FFmpeg, restart MkBoard and click “Rescan”.

HyperFrames CLI

HyperFrames renders HTML video projects locally. Follow HyperFrames Quickstart and heygen-com/hyperframes GitHub.

MkBoard uses a local hyperframes command first. If it is not installed globally, MkBoard can run HyperFrames through the official npx flow.

npx hyperframes doctor

Having npx available does not mean the full rendering environment is ready; Node.js and FFmpeg still need to pass.

Need Help

If setup or detection fails, join the Feishu group. We update the latest setup notes and fixes there.