Getting Started

Get CodeGraph running in 10 minutes with this quick start guide.

Documents

Document Description
Installation Detailed installation with PostgreSQL, LLM, GoCPG
Configuration Auth, rate limiting, CORS, LLM providers

Quick Start

Prerequisites

  • Python 3.11+
  • PostgreSQL 15+ (running and accessible)
  • 16GB RAM minimum
  • 50GB free disk space

Step 1: Clone and Install

git clone <repository-url>
cd codegraph

conda create -n codegraph python=3.11 && conda activate codegraph
pip install -r requirements.txt

Step 2: Configure Database

export DATABASE_URL="postgresql+asyncpg://postgres:your_password@localhost:5432/codegraph"

Step 3: Initialize Database

python -m src.api.cli init-db
python -m src.api.cli create-admin --username admin --password admin123

Step 4: Start API Server

uvicorn src.api.main:app --host 0.0.0.0 --port 8000

Step 5: Verify Installation

Open browser: http://127.0.0.1:8000/api/docs

Next Steps

  1. Import a project
  2. Run your first scenario
  3. Configure OpenCode