Quickstart

If you can open a terminal, you can run korgex. You'll need Python 3.10 or newer.

1. Install it

pip install -U korgex

2. Connect an AI

Run the guided setup and paste a key from whichever provider you use:

korgex setup

…or just set one and go — any of these works:

export ANTHROPIC_API_KEY="…"     # Claude
export OPENAI_API_KEY="…"        # ChatGPT
export KORGEX_API_KEY="…" KORGEX_API_URL="http://your-box:8000/v1"   # a local/self-hosted model

3. Ask for something — then check the receipt

Describe the job in plain words. When it's done, prove the run wasn't altered.

korgex "add a /healthz endpoint that returns 200 with uptime"
#   ➤ Read(routes.py)  ➤ Edit(routes.py)  ➤ Bash(pytest -q)
#   ✓ Added GET /healthz — tests pass

korgex verify
#   ✓ record intact — chain verified end-to-end

Living in it

Run bare korgex (no prompt) to drop into an interactive session with slash commands (/plan, /diff, /rewind, /verify, /cost), @file mentions, and !shell shortcuts. Next: how the receipts work →