​
Prerequisites

OpenOperator requires Python 3.11 or higher. We recommend using uv for Python environment management.

​
Clone the Repository

First, clone the OpenOperator repository:

git clone https://github.com/j0yk1ll/openoperator
cd openoperator

​
Environment Setup

  1. Create a virtual environment:
uv venv --python 3.11
  1. Install dependencies:
# Install all dependencies including dev packages
uv pip install . ."[dev]"

​
Configuration

Set up your environment variables:

# Copy the example environment file
cp .env.example .env

You can use any LLM model supported by LangChain. See LangChain Models for available options and their specific API key requirements.

​
Development

After setup, you can:

  • Try the examples in the examples/ directory
  • Run tests with pytest

​
Getting Help

If you run into any issues:

  1. Check our GitHub Issues
  2. Join our Discord community for support

We welcome contributions! See our Contribution Guide for guidelines on how to help improve OpenOperator.