Installation & Setup
Getting started with BeeAI on your system
BeeAI can be installed and used locally through the BeeAI CLI. Internally, this creates an automatically managed virtual machine for running agents. We offer support for macOS, Linux and Windows.
BeeAI requires macOS 13 (Ventura) or later.
Install uv
If you don’t have uv installed, install it using one of the supported ways.
Open a terminal and run:
After this, close the terminal and re-open it.
Install BeeAI
Start the BeeAI platform
Configure an LLM provider
BeeAI needs an LLM provider for the agents — like OpenAI, Ollama, Anthropic, etc.
If you don’t already have an API key for a provider, you can register for a free one on OpenRouter.
Run this command and follow the interactive prompts:
You can re-run this command anytime to change the LLM provider.
Check that everything works
Starting up an agent for a first time may take a few minutes. If everything is succesful, you should see a friendly greeting from the agent.
✨ Done! You are ready to use the BeeAI platform.
BeeAI requires macOS 13 (Ventura) or later.
Install uv
If you don’t have uv installed, install it using one of the supported ways.
Open a terminal and run:
After this, close the terminal and re-open it.
Install BeeAI
Start the BeeAI platform
Configure an LLM provider
BeeAI needs an LLM provider for the agents — like OpenAI, Ollama, Anthropic, etc.
If you don’t already have an API key for a provider, you can register for a free one on OpenRouter.
Run this command and follow the interactive prompts:
You can re-run this command anytime to change the LLM provider.
Check that everything works
Starting up an agent for a first time may take a few minutes. If everything is succesful, you should see a friendly greeting from the agent.
✨ Done! You are ready to use the BeeAI platform.
Install uv
If you don’t have uv installed, install it through one of the available ways:
Open a terminal and run:
Open a terminal and run:
Some Linux distributions package uv, but beware that some may include outdated versions.
Check the Repology website to see if your distribution packages uv.
Alternatively, you may install uv using pipx or cargo according to the official installation instructions.
If in doubt, just use the installation script.
After installing uv, run this to update your PATH:
After this, close the terminal and re-open it.
Install QEMU
Install QEMU according to the official instructions.
Alternatively, BeeAI platform can run using docker. In that case, QEMU is not needed. Runtime will be automatically detected.
Install BeeAI
Start the BeeAI platform
Configure an LLM provider
BeeAI needs an LLM provider for the agents — like OpenAI, Ollama, Anthropic, etc.
If you don’t already have an API key for a provider, you can register for a free one on OpenRouter.
Run this command and follow the interactive prompts:
You can re-run this command anytime to change the LLM provider.
Check that everything works
Starting up an agent for a first time may take a few minutes. If everything is succesful, you should see a friendly greeting from the agent.
✨ Done! You are ready to use the BeeAI platform.
BeeAI requires Windows 11 22H2 or later.
These steps guide you through installing BeeAI in PowerShell. If you wish, you may work in a WSL distribution instead. In that case, simply switch to the Linux instructions and skip installing QEMU.
Install uv
If you don’t have uv installed, install it using one of the supported ways.
Open PowerShell and run:
After this, close the terminal and re-open it.
Install BeeAI
Start the BeeAI platform
Configure an LLM provider
BeeAI needs an LLM provider for the agents — like OpenAI, Ollama, Anthropic, etc.
If you don’t already have an API key for a provider, you can register for a free one on OpenRouter.
Run this command and follow the interactive prompts:
You can re-run this command anytime to change the LLM provider.
Check that everything works
Starting up an agent for a first time may take a few minutes. If everything is succesful, you should see a friendly greeting from the agent.
✨ Done! You are ready to use the BeeAI platform.
Updating
Updating
Upgrade BeeAI
Restart the BeeAI platform
Done!
BeeAI platform is updated.
Uninstalling
Uninstalling
Remove the BeeAI platform instance
Uninstall the BeeAI platform
Done!
BeeAI platform is now fully removed.