ConduitR.Visualizer.Cli 1.0.5

ConduitR.Visualizer.Cli

Generate readable ConduitR flow documentation from a solution or project.

ConduitR.Visualizer.Cli is a .NET tool for teams that want to understand where mediator requests go, which handlers receive them, which pipeline behaviors wrap them, and where the calls appear in source code.

Install

dotnet tool install --global ConduitR.Visualizer.Cli --version 1.0.5

For prerelease builds:

dotnet tool install --global ConduitR.Visualizer.Cli --prerelease

Local tool manifest:

dotnet new tool-manifest
dotnet tool install ConduitR.Visualizer.Cli --version 1.0.5

Usage

conduitr visualize ./MyApp.sln --output ./artifacts/conduitr

or:

conduitr visualize ./src/MyApp.Api/MyApp.Api.csproj -o ./artifacts/conduitr

The command writes:

artifacts/conduitr/
  flows.md
  flows.json
  diagrams/
    *.mmd

What It Finds

• mediator.Send(...) request flows
• mediator.Publish(...) notification fan-out
• mediator.CreateStream(...) stream flows
• request, notification, and stream handlers
• pipeline behaviors registered through known ConduitR extensions
• handler constructor dependencies
• call sites with file and line links

Example Output

flows.md includes a human-readable report:

Request: CreateOrder
Response: CreateOrderResult
Handler: CreateOrderHandler

Called From:
  - OrdersEndpoint.cs:42

Pipeline:
  1. ValidationBehavior<CreateOrder, CreateOrderResult>
  2. LoggingBehavior<CreateOrder, CreateOrderResult>
  3. ResilienceBehavior<CreateOrder, CreateOrderResult>

Handler Dependencies:
  - IOrderRepository
  - ILogger<CreateOrderHandler>

Each Mermaid file can be rendered by GitHub, Mermaid CLI, documentation sites, or architecture portals:

sequenceDiagram
    participant Caller
    participant Mediator
    participant Validation
    participant Handler

    Caller->>Mediator: Send(CreateOrder)
    Mediator->>Validation: Handle
    Validation->>Handler: next()
    Handler-->>Caller: CreateOrderResult

CI Usage

The CLI is designed to run in CI so flow reports can be generated as build artifacts:

dotnet tool restore
dotnet tool run conduitr visualize ./ConduitR.sln --output ./artifacts/conduitr

Related Packages

• ConduitR.Visualizer.Core: reusable analysis and report generation engine
• ConduitR.Visualizer.Analyzers: Visual Studio/Roslyn design-time handler hints
• ConduitR: core mediator runtime

More Documentation

• Repository README
• Release 1.0.5 plan