Installation
Instructions for installing BeeAI
The BeeAI platform supports installation on macOS, Linux, and Windows (via WSL2) using multiple methods.
The preferred installation method is via Homebrew. Homebrew simplifies dependency management and automatically handles background services.
It’s also possible to install BeeAI directly from PyPI, with some required manual steps.
Install BeeAI with Homebrew
This method uses Homebrew. Homebrew can be used on all supported platforms: macOS, Linux and Windows (WSL2).
Install
Set-up Homebrew
If you are not already a user, first install Homebrew by running this command:
Install BeeAI
Update
Uninstall
Install BeeAI with Homebrew
This method uses Homebrew. Homebrew can be used on all supported platforms: macOS, Linux and Windows (WSL2).
Install
Set-up Homebrew
If you are not already a user, first install Homebrew by running this command:
Install BeeAI
Update
Uninstall
Install BeeAI with 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
Install a container runtime
Manually installed BeeAI needs you to provide a container runtime. If you already use one (Docker, Rancher, Podman, Colima, etc.), it will be detected and used for running agents.
If you don’t have one or are not sure, the simplest way is to install Rancher Desktop for your platform.
Install pipx
If you are not already a user, install pipx according to the official instructions.
If you use uv, you may use uv tool as an alternative to pipx, e.g. uv tool install beeai-cli.
Install BeeAI
Run the BeeAI server
The BeeAI server must remain running for the platform to function. Keep this command running in a separate terminal window:
Update
Uninstall
Post-installation setup
LLM provider setup
After installation, configure your preferred LLM provider.
To configure manually, follow these examples:
Verify installation
To verify the installation, run:
Ensure all agents display the ready status. Note that initial setup might take a few minutes.
At this point, you may also wish to enable Agent Traceability.