Local environment

MkBoard Local CLI Setup Guide

Set up Codex CLI, Claude Code, Node.js, FFmpeg, Dreamina CLI, and HyperFrames CLI from official sources so MkBoard Desktop can reuse local sessions for storyboard and video draft workflows.

Download desktop app

Check These First

  1. Choose one local Agent: Codex CLI or Claude Code. MkBoard uses it to read the current script, storyboard table, and project assets.
  2. HyperFrames rendering requires Node.js 22 or newer, plus FFmpeg available directly from your terminal.
  3. Seedance 2.0 video generation requires Dreamina CLI with a logged-in account and available balance.
  4. After installation, return to MkBoard Desktop settings and click “Rescan”.

MkBoard does not store credentials for Codex, Claude Code, Dreamina, or HyperFrames. It only reuses CLI sessions already available on your machine.

Official Sources

ToolOfficial sourceMkBoard use
Codex CLIOpenAI Codex CLI / openai/codex GitHubLocal Agent
Claude CodeClaude Code setup / Claude Code authenticationLocal Agent
Node.jsNode.js downloadsHyperFrames runtime
FFmpegFFmpeg Download / Homebrew ffmpegHyperFrames video encoding
HyperFramesHyperFrames Quickstart / heygen-com/hyperframes GitHubHTML video rendering
Dreamina CLIDreamina website / CLI installer URLLocal Seedance 2.0 video generation

Local Agent

Codex CLI

Codex CLI can act as MkBoard’s local Agent. It reads the current script, storyboard table, and project assets, then returns structured results. Official sources: OpenAI Codex CLI and openai/codex GitHub.

curl -fsSL https://chatgpt.com/codex/install.sh | sh
codex login --device-auth
codex login status

codex login status is the self-check command MkBoard Desktop uses to confirm the local login state. If browser login fails, prefer codex login --device-auth.

Claude Code

Claude Code can also act as the local Agent. MkBoard only checks the local claude command and login state. It does not upload Claude credentials. Official sources: Claude Code setup and Claude Code authentication.

curl -fsSL https://claude.ai/install.sh | bash
claude auth login
claude auth status --json

claude auth status --json is the self-check command MkBoard Desktop uses to confirm the local login state. After logging in, reopen your terminal and run it once to avoid stale PATH or session state.

Rendering Prerequisites

Node.js 22+

HyperFrames requires Node.js 22 or newer. Check your current version first:

node --version

If the version is lower than v22 or Node.js is missing, install a current version from the official Node.js download page. Reopen your terminal, then run node --version again.

FFmpeg

FFmpeg must be executable from your system terminal before HyperFrames can encode video. The official entry point is FFmpeg Download. On macOS with Homebrew, you can also use the Homebrew ffmpeg formula.

macOS:

brew install ffmpeg
ffmpeg -version

Ubuntu / Debian:

sudo apt update
sudo apt install ffmpeg
ffmpeg -version

Windows:

  1. Open FFmpeg Download, then go to Windows builds.
  2. Choose one of the build providers listed there, such as gyan.dev or BtbN, and download a release build.
  3. Extract it and add its bin directory to the system PATH.
  4. Reopen PowerShell and run ffmpeg -version.

If MkBoard still cannot find FFmpeg, check whether PATH was added only in a temporary shell profile. Desktop apps launched from the GUI may not inherit terminal-only environment variables, so restart MkBoard and click “Rescan”.

Video Tools

HyperFrames CLI

HyperFrames renders HTML video projects locally. Official sources: HyperFrames Quickstart and heygen-com/hyperframes GitHub. MkBoard uses a local hyperframes command first. If it is not installed globally, MkBoard can try to download the official package through npx.

node --version
ffmpeg -version
npx hyperframes doctor
npm install -g hyperframes

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

Dreamina CLI

Dreamina CLI is used for local Seedance 2.0 video generation. After installation, log in and confirm the account balance is available. Current public entry points are the Dreamina website and the official CLI installer URL https://jimeng.jianying.com/cli.

curl -fsSL https://jimeng.jianying.com/cli | bash
dreamina login
dreamina user_credit

Troubleshooting

Settings Shows Not Installed

Confirm the matching command works directly in your system terminal. Electron apps launched from the GUI may not always inherit your full PATH. After installation, restart MkBoard or click “Rescan”.

Settings Shows Login Required

Run the matching CLI login command in the system terminal. Do not paste third-party account tokens or secrets into MkBoard.

HyperFrames Or FFmpeg Check Fails

Confirm these commands work:

node --version
ffmpeg -version
npx hyperframes doctor

Node.js must be version 22 or newer. FFmpeg must be available in PATH. If npx hyperframes doctor reports missing FFmpeg, fix FFmpeg first using the installation steps above.

Dreamina Generation Fails

Check login and balance first:

dreamina user_credit

If the command reports that you are not logged in, run dreamina login, then return to MkBoard and rescan.