Skip to main content

​
Prerequisites

  • Basic terminal/command line experience
  • LLM API key (OpenAI, Anthropic, Gemini, watsonx, or free via OpenRouter / Groq) or Ollama (requires a powerful computer)
  • Fast internet (2–3GB download)

​
Installation

  • Linux & macOS
  • Windows

​
One-Line Install

Open the terminal and run this command to install BeeAI:
sh -c "$(curl -LsSf https://raw.githubusercontent.com/i-am-bee/beeai-platform/HEAD/install.sh)"
This interactive script installs BeeAI CLI, downloads and starts the platform, prompts you to configure your LLM API key, then launches the web interface.
1

Install uv

Follow the installation instructions.
2

Linux only: Install QEMU

Install QEMU via package manager (instructions).
3

Install BeeAI

Open a new terminal and run:
uv tool install --refresh --quiet --force beeai-cli && beeai self install
Follow the interactive prompts to finish installation and setup.

​
Usage

beeai ui                     # Launch web interface
beeai list                   # See what agents are available
beeai run chat "Hi!"         # Send a message to chat agent
beeai run chat               # Try interactive mode
beeai info chat              # View agent details
beeai --help                 # See all options

​
Platform Management

beeai platform start        # Start platform
beeai model setup           # Configure LLM provider
beeai platform stop         # Stop (keeps data)
beeai platform delete       # Delete all data

​
Version & Upgrades

If you are having issues with these commands, you may be running an old version of BeeAI. Run the one-line install script above to upgrade to the latest version.
beeai self version          # Check version
beeai self upgrade          # Update
beeai self uninstall        # Remove completely
Explore the rest of the documentation to learn how to connect MCP servers, build your own agents, use document retrieval, and more! 🐝
⌘I