Quickstart

This page is the fastest path from clone to first successful run.

1. Install The Runtime

We recommend uv for fast, reliable Python environment management.

uv venv --python 3.12
source .venv/bin/activate
uv pip install -e .[all]

If you prefer plain pip, python -m venv .venv && source .venv/bin/activate && pip install -e .[all] works too.

2. Add Optional Secrets

This step is only needed if you use online model providers (Anthropic, OpenAI, Google, etc.).

cp .env.example .env

Then fill in the keys you need.

3. Check Your Setup

gym-anything doctor

This command tells you what is installed, what is missing, and interactively asks your permissions to install the missing ones (eg, docker).

4. Load An Environment

from gym_anything import from_config

env = from_config(
    "benchmarks/cua_world/environments/moodle_env",
    task_id="enroll_student",
)

obs = env.reset(seed=42)
obs, reward, done, info = env.step([], mark_done=True)
env.close()

5. Run An Example Agent

gym-anything benchmark moodle --task enroll_student --agent ClaudeAgent --model claude-opus-4

6. Go Deeper

Installation

Fuller install checklist

First Run

A more realistic task flow

Core Overview

The core ideas behind the framework