ProjGraph

<div align="center">

# ProjGraph

**.NET tool ecosystem for visualizing project dependencies, database schemas, and class hierarchies.**

[![CI](https://github.com/HandyS11/ProjGraph/actions/workflows/ci.yml/badge.svg)](https://github.com/HandyS11/ProjGraph/actions/workflows/ci.yml)
[![CD](https://github.com/HandyS11/ProjGraph/actions/workflows/publish.yml/badge.svg)](https://github.com/HandyS11/ProjGraph/actions/workflows/publish.yml)
[![License](https://img.shields.io/github/license/HandyS11/ProjGraph)](./LICENSE)

[![ProjGraph.Cli NuGet](https://img.shields.io/nuget/v/ProjGraph.Cli?label=CLI&logo=nuget)](https://www.nuget.org/packages/ProjGraph.Cli)
[![ProjGraph.Cli Downloads](https://img.shields.io/nuget/dt/ProjGraph.Cli?label=CLI%20downloads&logo=nuget)](https://www.nuget.org/packages/ProjGraph.Cli)
[![ProjGraph.Mcp NuGet](https://img.shields.io/nuget/v/ProjGraph.Mcp?label=MCP&logo=nuget)](https://www.nuget.org/packages/ProjGraph.Mcp)
[![ProjGraph.Mcp Downloads](https://img.shields.io/nuget/dt/ProjGraph.Mcp?label=MCP%20downloads&logo=nuget)](https://www.nuget.org/packages/ProjGraph.Mcp)

</div>

**ProjGraph** is a .NET tool ecosystem for visualizing project dependencies, database schemas, and class hierarchies.
It provides both a CLI for manual analysis and an MCP server for AI-assisted exploration of your codebase architecture.

## 🚀 Quick Start

### CLI Tool

Install and use the command-line tool for immediate visualization:

```bash
# Install
dotnet tool install -g ProjGraph.Cli

# Visualize project dependencies
projgraph visualize ./MySolution.slnx

# Generate Entity Relationship Diagram (from DbContext or ModelSnapshot)
projgraph erd ./Data/MyDbContext.cs

# Generate Class Diagram for a class and its hierarchy
projgraph classdiagram ./Models/User.cs

# Compute key solution metrics (project counts, depth, hotspots)
projgraph stats ./MySolution.slnx
```

📖 [Full CLI Documentation](./src/ProjGraph.Cli/README.md)

### MCP Server

Configure your MCP client (e.g., GitHub Copilot, Claude) with the following settings:

> Find the latest version number on [NuGet](https://www.nuget.org/packages/ProjGraph.Mcp)

```json
{
  "servers": {
    "ProjGraph.Mcp": {
      "type": "stdio",
      "command": "dnx",
      "args": ["ProjGraph.Mcp@x.x.x", "--yes"]
    }
  }
}
```

📖 [Full MCP Documentation](./src/ProjGraph.Mcp/README.md)

## ✨ Key Features

- **📊 Multiple Output Formats**: ASCII tree and Mermaid.js diagrams
- **🗄️ Entity Relationship Diagrams**: Generate ERDs from EF Core `DbContext` or `ModelSnapshot` files
- **🏗️ Class Hierarchies**: Visualize class diagrams with inheritance and dependencies
- **📈 Solution Metrics**: Project counts, type breakdown, dependency depth, and hotspot detection
- **📁 Modern .NET Support**: Full support for `.slnx`, `.sln`, and `.csproj` files
- **🤖 AI Integration**: MCP server for GitHub Copilot, Claude, and other AI assistants
- **⚡ Fast & Reliable**: Efficient parsing and graph algorithms

## 🛠️ Development

### Prerequisites

- [.NET 10.0 SDK](https://dotnet.microsoft.com/download) or later

### Run Locally

```bash
# CLI
dotnet run --project src/ProjGraph.Cli -- visualize ./ProjGraph.slnx

# Stats
dotnet run --project src/ProjGraph.Cli -- stats ./ProjGraph.slnx

# MCP Server
dotnet run --project src/ProjGraph.Mcp
```

## 📝 Usage Examples

### Analyze Project Dependencies

```bash
# Mermaid format (default)
projgraph visualize ./MySolution.sln

# ASCII tree format
projgraph visualize ./MySolution.sln --format tree

# Mermaid format for documentation
projgraph visualize ./MySolution.slnx --format mermaid --output docs/dependencies.mmd
```

### Generate Database Diagrams

```bash
# Generate ERD from DbContext
projgraph erd ./Data/MyDbContext.cs

# Generate ERD from ModelSnapshot (leveraging migrations)
projgraph erd ./Migrations/MyDbContextModelSnapshot.cs

# Output to Markdown for documentation
projgraph erd ./Data/MyDbContext.cs --output docs/database-schema.md

# Control how EF Core owned types (OwnsOne/OwnsMany) are rendered:
# 'mirror' (default) inlines a table-split owned type onto its owner as EF names it;
# 'classic' gives every owned type its own entity box regardless of table mapping
projgraph erd ./Data/MyDbContext.cs --owned-mode classic
```

### Visualize Class Hierarchies

```bash
# Generate diagram for a class and its inheritance and dependencies
projgraph classdiagram ./Models/Admin.cs -i -d

# Control discovery depth (default: 1)
projgraph classdiagram ./Models/Admin.cs -i -d --depth 5
```

### Analyze Solution Metrics

```bash
# Display project counts, depth stats, and hotspot projects
projgraph stats ./MySolution.slnx

# Show top 10 most-referenced projects
projgraph stats ./MySolution.slnx --top 10
```

### With AI Assistants

Once the MCP server is configured:

```text
You: "Analyze the dependencies in my solution"
AI: [Generate the architecture diagram]

You: "Generate a class diagram for the User class"
AI: [Generates the class hierarchy]

You: "Show me the entity relationships in my DbContext"
AI: [Generates the database schema]

You: "Give me a health summary of my solution"
AI: [Returns project counts, depth stats, and hotspot projects]
```

## 🔗 Links

- **CLI Package**: [ProjGraph.Cli on NuGet](https://www.nuget.org/packages/ProjGraph.Cli)
- **MCP Package**: [ProjGraph.Mcp on NuGet](https://www.nuget.org/packages/ProjGraph.Mcp)

## 📚 Samples & Showcase

Explore live examples of ProjGraph's capabilities in the [Samples Showcase](./samples/README.md).
Available samples include:

- **E-commerce ERD**: Complex database model with inheritance and hierarchies.
- **Design Patterns**: Deep class diagrams showing pattern implementation.
- **Modular Architecture**: Project dependency visualization for modern solutions.
- **Simple Hierarchy**: Easy entry-level examples for new users.
- **Solution Metrics**: Architectural health summary with project counts, depth, and hotspots.

## 📚 Documentation

- [Architecture Overview](./ARCHITECTURE.md) - Solution structure and design decisions
- [Contributing Guide](./CONTRIBUTING.md) - How to contribute to the project
- [Security Policy](./SECURITY.md) - Security reporting guidelines