Skip to content

Install

Prerequisites

  • Python 3.12 or higher
  • At least one LLM API key: OpenAI, Anthropic, Gemini, DeepSeek, Groq, Mistral, or Together AI
  • Docker (optional, for containerized deployment)

Option A: Local Python install

bash
# Clone the repo
git clone https://github.com/webagent-cloud/webagent.git
cd webagent

# Install Python dependencies
pip install -r requirements.txt

# Create your .env file (copy the example and fill in your keys)
cp .env.example .env

Edit .env and add your credentials:

env
OPENAI_API_KEY=sk-...
# or any of these (only one LLM provider is required):
ANTHROPIC_API_KEY=sk-ant-...
GEMINI_API_KEY=...

# Browser provider (choose one)
BROWSER_PROVIDER=local
# BROWSER_PROVIDER=browserbase
# BROWSER_PROVIDER=steel

# Only needed if using cloud browser providers:
# BROWSERBASE_PROJECT_ID=...
# BROWSERBASE_API_KEY=...
# STEEL_API_KEY=...

Start the server:

bash
python server.py

The server listens on http://localhost:8000 by default.

Option B: Docker

bash
git clone https://github.com/webagent-cloud/webagent.git
cd webagent

# Build the image
docker build -t webagent .

# Run with your .env file
docker run -p 8000:8000 --env-file .env webagent

Option C: Docker Compose

bash
docker-compose up

Option D: Cloud (no install)

Use the managed cloud API at https://webagent.cloud. Create an account, go to https://webagent.cloud/api-keys to generate a key, and call the cloud endpoint directly. No local setup required.

Template / starter boilerplate

No official starter template or boilerplate repository is published separately. The GitHub repo itself (webagent-cloud/webagent) is the canonical starting point and ships with an .env.example file.