Skip to content

Building Locally

Follow these instructions to set up your development environment, build the gateway from source, and run it interactively.

🧩 Prerequisites

  • Python ≥ 3.11
  • make
  • (Optional) Docker or Podman for container builds
make venv install-dev serve

This will:

  1. Create a virtual environment in .venv/
  2. Install Python dependencies (including dev extras)
  3. Run the gateway using Gunicorn

🐍 Manual Python Setup

python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

This installs:

  • Core app dependencies
  • Dev tools (ruff, black, mypy, etc.)
  • Test runners (pytest, coverage)

🚀 Running the App

You can run the gateway with:

make serve         # production-mode (Gunicorn) on http://localhost:4444
make dev           # hot-reload (Uvicorn) on http://localhost:8000
make run           # executes ./run.sh with your current .env settings
RELOAD=true make run   # enable auto-reload via run.sh (same as ./run.sh --reload)
./run.sh --help    # view all supported flags

Use make dev during development for auto-reload on port 8000.

🔄 Live Reload Tips

When relying on run.sh, set RELOAD=true (or pass --reload) and DEV_MODE=true in your .env so settings match.

Also set:

DEBUG=true
LOG_LEVEL=debug

🧪 Test It

curl http://localhost:4444/health
curl http://localhost:4444/tools

You should see [] or registered tools (once added).