OpenBee
User Guide

Quick Start

Get OpenBee running in minutes

1. Generate Configuration

Run the interactive configuration wizard:

openbee config

This walks you through setting up:

  • Server host and port
  • Database path
  • Claude Code CLI path and timeout
  • MCP API key (auto-generated or manual)
  • Platform credentials (Feishu, DingTalk, WeCom, Telegram)

The configuration is saved to config.yaml by default. You can specify a different output path:

openbee config -o /path/to/config.yaml

2. Start the Server

openbee server

Or run as a background daemon:

openbee server -d

The web console is available at http://localhost:8080 (or your configured host:port).

3. Create a Worker

Open the web console and create your first worker:

  1. Navigate to the Workers page
  2. Click Create Worker
  3. Set a name (e.g., "Assistant") and description
  4. Optionally add initial memory to define the worker's personality

4. Send a Message

If you have a platform configured (e.g., Feishu), send a message to your bot in the IM app. OpenBee will route it to the appropriate worker.

Next Steps

On this page