​
Install the BeeAI platform

The BeeAI platform can be installed on Mac or Linux. We support multiple installation methods:

Install using Homebrew (recommended): A cross-platform package manager for Linux and Mac. This method will install all dependencies for you, as well as manage background services.

  1. If you don’t already use Homebrew, install it using the instructions provided on the homepage.
  2. Install BeeAI with: brew install i-am-bee/beeai/beeai && brew services start beeai
  3. (optional) Install the Arize Phoenix UI with: brew install i-am-bee/beeai/arize-phoenix && brew services start arize-phoenix
  4. Installation complete! Move to the next section to set up agent providers.
  5. UPDATING: Run brew update beeai to update to the newest version of the platform. Note that agents are auto-updated.

Install from PyPI: Python-native way of installing. This method is less preferred since it requires more manual steps to complete.

  1. Install pipx from your OS’s package manager (sudo apt install pipx, sudo dnf install pipx, sudo pacman -S python-pipx, …)
    • Alternative: You may create a virtual Python environment and use regular pip instead. In that case, be aware that BeeAI will be available only in the virtual environment you use.
    • Alternative: If you are a user of uv, you may use uv tool install ... instead of pipx install ....
  2. Install BeeAI with: pipx install beeai-cli
  3. (optional) Install the Arize Phoenix UI with: pipx install arize-phoenix
  4. 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: BeeAI uses uv to manage Python environments. Install uv using your OS’s package manager, or follow the official installation instructions.
    • JavaScript / TypeScript: BeeAI uses npx, part of Node.js, to manage JS/TS environments. Install node using your OS’s package manager, or follow the official installation instructions.
    • Docker: (optional: no built-in agents use this runtime) BeeAI uses the docker CLI to manage agent containers. If you are unsure how to setup a container runtime on your machine, we recommend Rancher Desktop.
  5. Open a new terminal window and run beeai serve. This will start the BeeAI service, and show you the logs. Keep this terminal window running in order to use the platform.
  6. (optional) Open a new terminal window and run PHOENIX_GRPC_PORT=8336 phoenix serve to run the Arize Phoenix UI. Also keep this terminal window open and running.
  7. Installation complete! Move to the next section to set up agent providers.
  8. UPDATING: Run pipx upgrade beeai to update to the newest version of the platform. Note that agents are auto-updated.

​
Set up API keys

After installation, it’s time to configure your API keys using the beeai env setup command. If you don’t have an API key and don’t want to pay, Groq and OpenRouter have some limited free offerings. And if your computer is powerful, you can run models locally with Ollama.

After setting environment variables, run beeai provider list and check that all of the providers are in the ready state. It might take a while the first time. Repeat beeai provider list to see the current staus.

​
Visit the UI

  • BeeAI: http://localhost:8333

  • Arize Phoenix: http://localhost:6006