Installation
Instructions for installing BeeAI
The BeeAI platform supports installation on macOS, Linux, and Windows (via WSL) using multiple methods.
Homebrew (recommended)
The preferred installation method is via Homebrew. Homebrew simplifies dependency management and automatically handles background services.
Install
Update
Uninstall
PyPI
This method installs BeeAI using Python’s package manager but is not recommended due to additional manual setup requirements. It does not automatically manage dependencies or background services.
Install
This installation method is unsupported. We strongly recommend using the Homebrew method.
Install pipx
Follow the official instructions to install pipx.
Install BeeAI
Install agent runtimes
These are optional, but you won’t be able to use agents, including built-in ones, if the corresponding runtime is not available.
- Python runtime: Install uv.
- JavaScript/TypeScript runtime: Install Node.js.
- Docker runtime: This is optional since currently no built-in agents require Docker. If desired, we recommend Rancher Desktop.
Run BeeAI server:
The BeeAI server must remain running for the platform to function.
Update
Uninstall
Post-installation setup
LLM provider setup
After installation, configure your preferred LLM provider.
Verify installation
To verify the installation, run:
Ensure all providers display the ready
status. Note that initial setup might take a few minutes.
At this point, you may also wish to enable Agent Traceability.