Installation

Baize is self-hosted: it runs on your machine or on a server you control.

Prerequisites

• Node.js >= 20
• A Linux server or macOS
• A Claude subscription or an OpenAI Codex setup (Codex CLI v0.129.0+, 0.146+ recommended)

Manual install (npm)

npm install -g @baize-ai/core
baize init

The baize CLI is published to npm as @baize-ai/core. baize init sets up the whole environment and is safe to re-run at any time.

Docker deployment

The Docker image is built from the published @baize-ai/core npm package — no source code in the build.

Global (GitHub Container Registry):

docker run -d --name baize \
  -p 3456:3456 \
  -v baize-data:/home/baize/baize \
  -v claude-config:/home/baize/.claude \
  ghcr.io/baize01-ai/baize-core:latest

China (Aliyun ACR — fast, no mirror needed):

docker run -d --name baize \
  -p 3456:3456 \
  -v baize-data:/home/baize/baize \
  -v claude-config:/home/baize/.claude \
  crpi-8bg62qbrjs3cr3as.cn-hangzhou.personal.cr.aliyuncs.com/baize01/baize-core:latest

• baize-data — agent home (~/baize): memory, skills, services
• claude-config — the AI runtime's configuration (~/.claude)
• Port 3456 — the web console

See Docker Deployment for Compose setup, optional auth environment variables and volume details.

After install

Open http://localhost:3456 for the web console and configure authentication under Model settings — Claude API key / setup token / custom endpoint, or Codex / ChatGPT login.

Mainland China: the Codex mode is the default (save an API key and it takes effect immediately, no OAuth login needed). Switching to Claude Code (cc) is not recommended — the official service is unreachable and the agent will fail to start. For third-party OpenAI-compatible APIs (e.g. DeepSeek), fill in the provider's base_url and model name.

First-conversation tip: once configured, send the following in the Chat window to confirm the npm registry is reachable (the agent executes it and replies once a third-party API key is set):

Please check whether the current npm registry is https://registry.npmmirror.com; if not, switch the global npm registry to https://registry.npmmirror.com.