Installation
Quick Install
The install script auto-detects uv, pipx, or pip (and installs uv if none are found):
curl -fsSL https://initrunner.ai/install.sh | shInstall with extras
curl -fsSL https://initrunner.ai/install.sh | sh -s -- --extras ingestPin a specific version
curl -fsSL https://initrunner.ai/install.sh | sh -s -- --version 0.2.0Package Managers
pip install initrunner
uv tool install initrunner
pipx install initrunnerDocker
Pull and run in one command:
docker run --rm -e OPENAI_API_KEY vladkesler/initrunner:latest --versionOr use Docker Compose for the full dashboard:
curl -O https://raw.githubusercontent.com/vladkesler/initrunner/main/docker-compose.yml
docker compose up -dBuild locally with custom extras:
docker build -t initrunner .
docker build --build-arg EXTRAS="dashboard,anthropic" -t initrunner-custom .If using Ollama on the host from inside a container, set base_url: http://host.docker.internal:11434/v1 in your role YAML.
See Docker for full Docker documentation.
Extras
| Extra | Install command | What it adds |
|---|---|---|
anthropic | pip install initrunner[anthropic] | Anthropic provider |
google | pip install initrunner[google] | Google provider |
groq | pip install initrunner[groq] | Groq provider |
mistral | pip install initrunner[mistral] | Mistral provider |
all-models | pip install initrunner[all-models] | All providers |
cohere | pip install initrunner[cohere] | Cohere provider |
bedrock | pip install initrunner[bedrock] | AWS Bedrock provider |
xai | pip install initrunner[xai] | xAI provider |
ingest | pip install initrunner[ingest] | Additional formats: PDF, DOCX, XLSX (base text ingestion is built-in) |
local-embeddings | pip install initrunner[local-embeddings] | Local embedding models |
safety | pip install initrunner[safety] | Content safety / guardrail models |
dashboard | pip install initrunner[dashboard] | Web dashboard (FastAPI + Next.js) |
tui | pip install initrunner[tui] | Terminal TUI dashboard (Textual) |
Development Setup
git clone https://github.com/vladkesler/initrunner.git
cd initrunner
uv sync
uv run pytest tests/ -v
uv run ruff check .
uv run initrunner --versionEnvironment Variables
By default, InitRunner stores data in ~/.initrunner/. Override with INITRUNNER_HOME:
export INITRUNNER_HOME=/data/initrunner
initrunner run role.yaml -p "hello"Resolution order: INITRUNNER_HOME > XDG_DATA_HOME/initrunner > ~/.initrunner.
Platform Notes
- Python 3.11+ is required.
- Linux / macOS / WSL are fully supported.
- Windows works but systemd-related compose features (
compose install/start/stop) are unavailable. - Docker: if using Ollama on the host from inside a container, set
base_url: http://host.docker.internal:11434/v1in your role YAML.