Installation

Follow the steps below to get Codumentor running locally.

Prerequisites

• Git
• An API key from an OpenAI-compatible provider (e.g. OpenAI, OpenRouter, Google Gemini)

Download Portable Version

You can download the portable codumentor.exe from our releases page.

Initial Configuration

On the first run (TUI launch or ingest command), when no codumentor.yaml is found, Codumentor will prompt you to create a sample configuration file. You can also manually create one as shown in the Configuration guide.

Environment Variables

At minimum Codumentor needs an API key for embeddings and/or chat completion.

# Single key for everything
export OPENAI_API_KEY="sk-..."

Optionally use separate keys (useful when your provider does not offer embeddings):

export OPENAI_EMBEDDING_API_KEY="sk-embedding-..."
export OPENAI_AGENT_API_KEY="sk-agent-..."

Development Quick Start

You need Python 3.8 – 3.12

# Clone the repository
git clone https://github.com/<your-org>/codumentor.git
cd codumentor

# Install runtime dependencies
pip install -r requirements.txt

Running Tests (optional)

python -m unittest discover

Once installed, continue with the Configuration guide.