Installation¶

Prerequisites¶

Python 3.11+
uv (recommended) or pip

Option 1: Install with uv (Recommended)¶

The easiest way to install CodexSpec is using uv:

uv tool install codexspec

Option 2: Install with pip¶

Alternatively, you can use pip:

pip install codexspec

Option 3: One-time Usage¶

Run directly without installing:

# Create a new project
uvx codexspec init my-project

# Initialize in an existing project
cd your-existing-project
uvx codexspec init . --ai claude

Option 4: Install from GitHub¶

For the latest development version:

# Using uv
uv tool install git+https://github.com/Zts0hg/codexspec.git

# Using pip
pip install git+https://github.com/Zts0hg/codexspec.git

# Specific branch or tag
uv tool install git+https://github.com/Zts0hg/codexspec.git@main
uv tool install git+https://github.com/Zts0hg/codexspec.git@v0.2.0

Verify Installation¶

codexspec --help
codexspec version

Upgrading¶

# Using uv
uv tool install codexspec --upgrade

# Using pip
pip install --upgrade codexspec

Next Steps¶

Quick Start