Skip to main content

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.

​
Requirements

  • Python 3.10 or later (up to 3.13)
  • An API key from a supported LLM provider (OpenAI, Anthropic, or Google)

​
Install from PyPI

pip install arksim

​
Optional provider extras

ArkSim uses OpenAI by default. To use other providers, install the corresponding extra: 
# Anthropic
pip install "arksim[anthropic]"

# Google
pip install "arksim[google]"

# All providers
pip install "arksim[all]"

​
Install from source

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

arksim --help
You should see the available commands: simulate, evaluate, simulate-evaluate, show-prompts, examples, and ui.
You’re all set! Continue to the Quickstart guide to run your first simulation.