Blast-Radius Aware AI Code Review for Business-Critical Systems
LiveReview LiveReview Explore LiveReview
How to install THU-MAIC/OpenMAIC. Official installation instructions. Project installation guide. Framework or library installation. Build installation instructions. How to setup and install from GitHub. Installation steps and setup instructions. Official docs and installation instructions GitHub.

THU-MAIC/OpenMAIC Installation Guide

How to install THU-MAIC/OpenMAIC. Official project installation instructions and setup guide.

⚡

Automated Install (Recommended)

Quick installation instructions for THU-MAIC/OpenMAIC. This is the fastest way to complete project installation and setup.

Install via curl

curl -fsSL https://hexmos.com/ipm-install | bash && 
ipm i THU-MAIC/OpenMAIC
or

Install via npx

npx @hexmos/ipm i THU-MAIC/OpenMAIC

Prerequisites

Node.js

dependency

Version: >=20

pnpm

dependency

Version: >=10

Docker

dependency

Version: latest

ffmpeg

dependency

Version: latest

PostgreSQL

dependency

Version: latest

Manual Installation Methods

Manual installation instructions. How to install from GitHub source.

Clone & Install

git clone https://github.com/THU-MAIC/OpenMAIC.git

cd OpenMAIC

pnpm install

Configure (using .env.local)

cp .env.example .env.local

echo 'OPENAI_API_KEY=sk-...' >> .env.local

Run (Development)

pnpm dev

Run (Production)

pnpm build

pnpm start

Docker Deployment

cp .env.example .env.local

echo 'YOUR_API_KEYS' >> .env.local

docker compose up --build

Docker Deployment with China Build Acceleration

cp .env.example .env.local

echo 'YOUR_API_KEYS' >> .env.local

ALPINE_MIRROR=mirrors.tuna.tsinghua.edu.cn NPM_REGISTRY=https://registry.npmmirror.com docker compose up --build

Server-backed Persistence (PostgreSQL)

cp .env.example .env.local

printf '\nDATABASE_URL=postgres://openmaic:openmaic-dev@postgres:5432/openmaic\nPERSISTENCE_DEV_TOKEN=openmaic-local-dev\n' >> .env.local

NEXT_PUBLIC_PERSISTENCE=1 NEXT_PUBLIC_PERSISTENCE_TOKEN=openmaic-local-dev docker compose --profile server-persistence up --build

Agent Workbench and Runtime

cp .env.example .env.local

printf '\nNEXT_PUBLIC_PRO_WORKBENCH_ENABLED=true\nOPENMAIC_AGENT_RUNTIME_ENABLED=true\n' >> .env.local

printf 'DATABASE_URL=postgres://openmaic:openmaic-dev@postgres:5432/openmaic\n' >> .env.local

printf 'MODEL_ROUTES=''{\"maic-agent-driver\":{\"model\":\"openai:gpt-5.5\",\"api\":\"openai-completions\"}}'' >> .env.local

NEXT_PUBLIC_PERSISTENCE=1 NEXT_PUBLIC_PERSISTENCE_TOKEN=openmaic-local-dev docker compose --profile server-persistence up --build

MP4 Video Export (Render Service)

docker compose --profile video-export up --build

MinerU (Advanced Document Parsing)

cp .env.example .env.local

printf '\nPDF_MINERU_BASE_URL=http://your-mineru-instance:port\n' >> .env.local

VoxCPM2 (Self-Hosted TTS)

cp .env.example .env.local

printf '\nTTS_VOXCPM_BASE_URL=http://localhost:8000/v1\n' >> .env.local

Post Installation Steps

  • Open http://localhost:3000 in your browser.
  • For production builds, run 'pnpm build && pnpm start'.
← Back to serverAll Installation Guides