Skip to content

Installation

Prerequisites

  • Python 3.10+
  • PostgreSQL 15+
  • Node.js 18+ (for web UI)

Quick Install

1. Clone the repository

git clone https://github.com/chriswritescode-dev/codedox.git
cd codedox

2. Set up Python environment

python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -r requirements.txt

# Install Playwright browsers (required for crawling)
playwright install

3. Configure environment

cp .env.example .env
# Edit .env with your settings

4. Initialize database

python cli.py init

5. Install frontend dependencies

cd frontend
npm install
cd ..

Docker Installation

docker-compose up

This will start all services including PostgreSQL, API server, web UI, and MCP HTTP endpoints.

Start Services

After installation, start CodeDox with:

# Start all services (API, Web UI, MCP endpoints)
python cli.py serve

# Available endpoints:
# - Web UI: http://localhost:5173
# - API: http://localhost:8000  
# - MCP Tools: http://localhost:8000/mcp

For AI assistants, connect directly to the MCP endpoint at http://localhost:8000/mcp using Streamable HTTP transport.