Skip to main content
This guide will get you from zero to visualizing a codebase in under 5 minutes.
Make sure you’ve completed the Installation guide first.

​
Step 1: Analyze a Codebase

Let’s analyze a .NET solution. You can use any .sln file, or try CodeGraph on itself: 
npx @dotenvx/dotenvx run -- sh -c 'dotnet run --project src/adapters/driving/cli -- analyze ./CodeGraph.sln'
The sh -c wrapper is needed because some systems have a binary called analyze in PATH that can interfere with argument parsing.
You’ll see output like: 
Analyzing ./CodeGraph.sln...
Found 12 projects
Extracting nodes... 847 classes, 234 interfaces
Extracting edges... 2,341 dependencies
Saving to Neo4j... done

Analysis complete!
  - Nodes: 1,081
  - Edges: 2,341
  - Time: 4.2s

​
Step 2: Start the API Server

In your first terminal: 
npx @dotenvx/dotenvx run -- dotnet run --project src/adapters/driving/api
The API server starts on http://localhost:5050.

​
Step 3: Start the Web Frontend

In a second terminal: 
cd src/adapters/driving/web
pnpm dev
The frontend starts on http://localhost:5173.

​
Step 4: Explore!

Open http://localhost:5173 in your browser.
Your first CodeGraph visualization

​
Controls

ActionMouseKeyboard
RotateLeft click + drag-
PanRight click + dragArrow keys
ZoomScroll wheel+/-
Select nodeClick-
Focus nodeDouble-click-

​
One-Command Startup

For convenience, you can start everything with a single command: 
./start.sh
This starts:
  • Neo4j (checks if running, starts if not)
  • GraphPU GPU Server (if available)
  • API Server
  • Web Frontend
Press Ctrl+C to stop all services.

​
Try Different Codebases

# Analyze any .NET solution
codegraph analyze /path/to/YourProject.sln

# Analyze with verbose output
codegraph analyze ./Project.sln --verbose

# Analyze specific project only
codegraph analyze ./Project.csproj

​
What’s Next?

Explore the 3D Graph

Learn navigation controls and features

Using Overlays

Add git activity, coverage, and more

GPU Layout

Speed up layout for large graphs

Configuration

Customize CodeGraph for your needs