Skip to content

Installation

Get ORC up and running in minutes.

Standard Installation

Install ORC from PyPI:

pip install orc-arena

This installs the core framework with no LLM dependencies. You can use it with mock agents right away.

With LLM Providers

ORC works with any LLM provider. Install with provider-specific dependencies:

OpenAI (GPT-4, GPT-3.5, etc.)

pip install orc-arena[openai]

Requires an OpenAI API key. Set it via environment:

export OPENAI_API_KEY="sk-..."

Anthropic (Claude)

pip install orc-arena[anthropic]

Requires an Anthropic API key:

export ANTHROPIC_API_KEY="sk-ant-..."

Ollama (Local Models)

pip install orc-arena[ollama]

Requires Ollama running locally. No API key needed. Download models from ollama.ai.

ollama pull qwen2.5:72b  # or any available model

All Providers

pip install orc-arena[all]

Installs support for OpenAI, Anthropic, and Ollama. Pick which ones you use.

Development Installation

Clone the repository and install in editable mode:

git clone https://github.com/Lumi-node/ORC.git
cd ORC

pip install -e ".[dev]"  # Installs dev dependencies, tests, examples

Run tests to verify:

pytest tests/ -v

Run the quick battle example (no LLM needed):

python examples/quick_battle.py

Verify Installation

Test that ORC is installed and ready:

python -c "from orc import Arena, Warrior, Elder; print('Ready for battle')"

You should see:

Ready for battle

Docker

ORC includes a Dockerfile. Build and run:

docker build -t orc .
docker run orc

Python Compatibility

ORC requires Python 3.10+. Check your version:

python --version

Next Steps