Skip to main content
CodeGraph requires a few dependencies to run. This guide walks you through setting everything up.

​
Prerequisites

.NET 8 SDK

Required for the analysis engine and API server

Neo4j

Graph database for storing code structure

Node.js 18+

Required for the web frontend

pnpm

Package manager for the frontend

​
Optional (for GPU acceleration)

  • Rust 1.70+ - For building the GPU layout engine
  • Metal (macOS) or Vulkan (Linux/Windows) - GPU compute support

​
Step 1: Install Neo4j

​
Step 2: Clone CodeGraph

git clone https://github.com/rofox/codegraph.git
cd codegraph

​
Step 3: Configure Environment

# Copy the example environment file
cp .env.example .env
Edit .env and set your Neo4j credentials: 
Neo4j__Uri=bolt://localhost:7687
Neo4j__Username=neo4j
Neo4j__Password=your-password
Neo4j__Database=neo4j
For production, encrypt your .env file:
npx @dotenvx/dotenvx encrypt

​
Step 4: Install Dependencies

# .NET dependencies (automatic on build)
dotnet restore

# Frontend dependencies
cd src/adapters/driving/web
pnpm install

​
Step 5: Verify Installation

# Build everything
dotnet build

# Run tests
dotnet test
If all tests pass, you’re ready to go!

​
GPU Layout Engine (Optional)

For large codebases (1000+ nodes), the GPU layout engine provides significantly faster graph layout computation.
1

Install Rust

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
2

Build GraphPU

cd lib/graphpu
cargo build --features server --bin graphpu-server --release
3

Verify GPU Support

./target/release/graphpu-server --check
# Should output: Metal (macOS) or Vulkan (Linux/Windows) available

​
What’s Next?

Quickstart

Analyze and visualize your first codebase