> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arklex.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> Install ArkSim and get ready to simulate and evaluate your AI agents.

# Installation

## Requirements

* Python 3.10 or later (up to 3.13)
* An API key from a supported LLM provider ([OpenAI](https://developers.openai.com/api/docs), [Anthropic](https://platform.claude.com/docs/en/home), or [Google](https://ai.google.dev/gemini-api/docs/api-key))

## Install from PyPI

```bash theme={null}
pip install arksim
```

### Optional provider extras

ArkSim uses OpenAI by default. To use other providers, install the corresponding extra:

```bash theme={null}
# Anthropic
pip install "arksim[anthropic]"

# Google
pip install "arksim[google]"

# All providers
pip install "arksim[all]"
```

## Install from source

```bash theme={null}
git clone https://github.com/arklexai/arksim.git
cd arksim
pip install -e ".[dev]"
```

This installs in editable mode with test dependencies (`pytest`, `pytest-asyncio`).

## Verify installation

```bash theme={null}
arksim --help
```

You should see the available commands: `simulate`, `evaluate`, `simulate-evaluate`, `show-prompts`, `examples`, and `ui`.

<Check>
  You're all set! Continue to the [Quickstart guide](./quickstart) to run your first simulation.
</Check>