Skip to main content

System Requirements

Minimum

  • Python 3.10+
  • 2 CPU cores
  • 4GB RAM
  • 10GB disk space

Recommended

  • Python 3.11+
  • 4 CPU cores
  • 8GB RAM
  • 20GB disk space

Installation Methods

Choose the installation method that best fits your use case:
Best for: Development, testing, learning

Step-by-Step Installation

1

Install Python

Ensure Python 3.11 or higher is installed:
If not installed:
  • macOS: brew install python@3.11
  • Ubuntu: sudo apt install python3.11
  • Windows: Download from python.org
2

Install Docker

Required for OpenFGA, Jaeger, and other infrastructure:Verify installation:
3

Clone Repository

4

Install uv Package Manager

Install uv (recommended for fast dependency management):
uv is 10-100x faster than pip and handles virtual environments automatically!
5

Install Dependencies

No manual venv creation needed! uv sync automatically:
  • Creates .venv if it doesn’t exist
  • Installs all dependencies from pyproject.toml
  • Uses uv.lock for reproducible builds
Or use the Makefile:
requirements.txt files are deprecated.* All dependencies are managed via pyproject.toml and locked in uv.lock for reproducible builds.

Post-Installation Setup

1. Start Infrastructure Services

Verify services are running:
All services should show “Up” status.

2. Setup OpenFGA

Initialize the authorization system:
Save the output values:
  • OPENFGA_STORE_ID
  • OPENFGA_MODEL_ID

3. Configure Environment

Create .env from the example:
Edit .env with your values:

4. Add OpenFGA IDs

Add to .env:

5. Test Installation

You should see successful responses from the agent!

Verification

Run the full test suite to verify everything is working:

Optional: Development Tools

Install additional tools for development:

Platform-Specific Notes

macOS Installation

Use Homebrew for easy installation:

Ubuntu Installation

Windows Installation

  1. Install Python:
    • Download from python.org
    • Check “Add Python to PATH” during installation
  2. Install Docker Desktop:
  3. Install Git:
  4. Use PowerShell or Git Bash for terminal commands

ARM64 Support

The project fully supports ARM64:
On Apple Silicon Macs, use native Python, not Rosetta!

Troubleshooting

Problem: Dependencies fail to installSolution:
uv handles most dependency resolution issues automatically and is much faster than pip!
Problem: docker: command not foundSolution:
  • Ensure Docker Desktop is running (macOS/Windows)
  • Add Docker to PATH (Linux: sudo usermod -aG docker $USER)
  • Restart terminal
Problem: Permission errors when running DockerSolution:
Problem: Address already in useSolution:

Next Steps

First Request

Send your first message to the agent

Configuration

Configure LLM providers and settings

Development Setup

Set up your development environment

Deploy

Deploy to production