User Guide
Quick Start
Get OpenBee running in minutes
1. Generate Configuration
Run the interactive configuration wizard:
openbee configThis 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.yaml2. Start the Server
openbee serverOr run as a background daemon:
openbee server -dThe 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:
- Navigate to the Workers page
- Click Create Worker
- Set a name (e.g., "Assistant") and description
- 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
- Configuration Reference — Full config.yaml documentation
- Platform Setup — Connect your IM platform
- Workers — Create and manage AI workers