ISSUE 2026-06-20 · SATURDAY, JUNE 20 clawcodex · v0.5.0
install

Install ClawCodex

Python 3.10+ on macOS, Linux, or WSL. No account, no telemetry — bring your own API key.

step 01

Install

Clone the repo, create a virtual environment, and install requirements. Python 3.10+ on macOS, Linux, or WSL.

git clone https://github.com/agentforce314/clawcodex.git
cd clawcodex
python3 -m venv .venv && source .venv/bin/activate
pip install -r requirements.txt

Prefer uv? uv venv --python 3.11 && uv pip install -e ".[dev]" gives you the clawcodex entry point.

step 02

Configure

Run the interactive login. It asks for a provider, an API key, an optional base URL and default model, then sets your default provider. Config is written to ~/.clawcodex/config.json.

python -m src.cli login
# or, with the entry point installed:
clawcodex login

TAVILY_API_KEY (from tavily.com) is required for the WebSearch tool. Add it under the env block of your config.

step 03

First run

Start the REPL in any project. Plan mode is read-only by default; switch to an editing mode when you are ready to let it act.

cd path/to/project
clawcodex
# headless / scripting:
clawcodex -p "Summarize src/cli.py"

Inside the REPL, type / to see commands and skills, /tools to list the registry, and /tui to hand off to the Textual UI.

step 04

Other ways to install

Pick the row that matches your setup. Each path installs the same clawcodex runtime.

uv (editable)
uv venv --python 3.11
source .venv/bin/activate
uv pip install -e ".[dev]"

Installs the package plus the clawcodex entry point and dev extras.

pip (editable)
uv pip install -r requirements.txt
uv pip install -e .

Requirements first, then an editable install of the package.

From source
git clone https://github.com/agentforce314/clawcodex.git
cd clawcodex
pip install -e .[dev]

Useful for hacking on the runtime itself or contributing patches.

step 05

Where config lives

Configuration and session state live under your home directory.

~/.clawcodex/
├── config.json      providers, models, advisor, env
├── skills/          user skills (each with SKILL.md)
└── sessions/        saved conversations
./.clawcodex/        project-scoped skills (optional, per-repo)

On first run the CLI offers to create a config file if one is missing. Keys are obfuscated at rest.