Requirements
| Requirement | What you need |
|---|---|
| Operating system | macOS, Windows, or Linux on x64 or arm64 |
| Docker | A running Docker engine with Compose 2.20 or newer |
| Memory | 8 GB recommended |
| Disk | 8 GB free recommended. Updates need at least 4 GB free. |
| Ports | 8787 for the server (you can change it), 6200–6299 for bot screens, and 80 and 443 if you use automatic HTTPS |
| AI model | A ChatGPT or Claude subscription, an API key, or a compatible endpoint |
On macOS and Windows, install and open Docker Desktop. On Linux, install Docker Engine and the Compose plugin. Installing only the docker command-line tool isn't enough; the engine must be running.
Bots only work while the host is on. If you want them to keep working while your laptop is closed, install on a machine that stays on. See how hosting works.
Install
macOS or Linux
curl -fsSL https://openteam.so/install | shWindows PowerShell
irm https://openteam.so/install.ps1 | iexThe installer downloads and verifies the openteam command-line tool, checks Docker, downloads the server, and starts guided setup. If a check fails, fix it and run openteam setup. You don't need Node.js or Bun. You can read the installer before running it.
The tool is installed to ~/.local/bin on macOS and Linux. If your terminal can't find openteam, add that directory to your PATH. On Windows, it's installed to %LOCALAPPDATA%\OpenTeam\bin and added to your PATH; open a new terminal if the command isn't found.
Guided setup
Setup asks for:
- Your account. OpenTeam has one account per server. Use it to sign in from all your devices.
- A model provider. See model providers for the options. You can skip this and connect one later with
openteam setup.
If setup can't find a private network address, it first asks for the address your devices will use to reach the server. It then shows a summary. Choose Start OpenTeam to start the server. Setup detects a private network address, or your Tailscale HTTPS address if your tailnet has HTTPS turned on, and prints the server URL to use in the apps.
Run openteam setup --advanced to choose a different connection mode, API port, time zone, or number of tasks that run at once. See server settings.
To change your username or password later, see server commands.
Check the installation
openteam status
openteam doctorstatus shows the server URL, version, and health of each service. doctor runs deeper checks.
Where OpenTeam is installed
Configuration lives in ~/.openteam on macOS and Linux (or $XDG_CONFIG_HOME/openteam if that variable is set), and %LOCALAPPDATA%\OpenTeam on Windows. To use a different directory, set OPENTEAM_HOME or pass --dir <path> to any command. Your bots' data is stored in Docker volumes, not in this directory. See backups.
To run unreleased code or contribute, see development from source.