Skip to content

Quick Start

Get a live Baize agent on your machine in a few minutes.

Prerequisites

  • A Linux server (or macOS)
  • A Claude subscription — or an OpenAI Codex setup (Codex CLI v0.129.0+, 0.146+ recommended)

One-command install

bash
curl -fsSL https://raw.githubusercontent.com/baize01-ai/baize-core/main/scripts/install.sh | bash

This installs the dependencies (git, tmux, Node.js, PM2, the baize CLI) and runs baize init to set up the agent.

Mainland China: raw.githubusercontent.com is unreachable. Use the npmmirror micro-package instead — add --cn to enable the full mainland pipeline (npmmirror registry, automatic Node binary install, native module source builds) and the Codex runtime by default:

bash
curl -fsSL https://registry.npmmirror.com/@baize-ai/install/-/install-0.1.8.tgz | tar xz -O package/install.sh | bash -s -- --cn

Manual install

Requires Node.js >= 20:

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

baize init is idempotent and supports interactive and non-interactive modes. It will:

  1. Install missing tools (tmux, git, PM2, Claude Code or Codex)
  2. Set up authentication (Claude: browser login, API key or setup token; Codex: API key or device auth)
  3. Create ~/baize/ with memory, skills and services
  4. Start background services and launch the agent in a tmux session

Talk to your agent

bash
baize shell        # Interactive CLI
baize attach       # Attach to the agent tmux session (Ctrl+B d to detach)
baize add feishu   # Install a messaging channel (npm)

Next steps