FlowLite.Diag 8.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet tool install --global FlowLite.Diag --version 8.0.0
This package contains a .NET tool you can call from the shell/command line. 
dotnet new tool-manifest
                    


                            if you are setting up this repo
                        

                    

                
dotnet tool install --local FlowLite.Diag --version 8.0.0
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=FlowLite.Diag&version=8.0.0
                    


                    

                
nuke :add-package FlowLite.Diag --version 8.0.0

FlowLite.Diag

FlowLite.Diag is a cross-platform .NET CLI tool for visualizing finite state machine (FSM) state transitions based on FlowTransitionBuilder code from the FlowLite library.

Features

  • Scans .cs files and locates all FlowTransitionBuilder<...> instances.
  • Generates Mermaid.js or DOT (Graphviz) diagrams from C# code.
  • Automatically separates transitions by builder instance.
  • Displays file path and per-builder FSM diagrams in the output.

Getting Started

When to Use FlowLite.Diag?

  • Designing workflows and business processes using FlowLite
  • Auto-generating documentation from source.
  • Visual debugging of state transitions.

Prerequisites

  • .NET 8 or higher.
  • Install the library FlowLite package.
  • C# source using FlowTransitionBuilder of FlowLite package.

Installation

To install the latest version of the FlowLite.Diag package:

NuGet Package Manager

Installation

dotnet tool install -g flowlite-diag --add-source ./nupkg

Uninstallation

dotnet tool uninstall -g flowlite-diag

Usage Guide

Usage command

flowlite-diag --source "C:\Orders\" --format "mermaid"
Argument Description Example
--source, -s Specifies the path to the project directory. "C:\Orders"
--format, -f Specifies the export format of the output. Supported values: dot or mermaid. "mermaid"

Example Diagram (Mermaid)

stateDiagram-v2
    Pending --> Created : Create
    Created --> Shipped : Ship
    Shipped --> Canceled : Cancel
    Failed --> Deleted : Delete

License

This project is licensed under the MIT License.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net8.0

    • No dependencies.
Version Downloads Last updated
8.0.0 152 4/20/2025

- Added support for .NET 8.0;
           - Initial release of FlowLite.Diag;
           - Analyze source files for FlowTransitionBuilder usage;
           - Generate FSM diagrams (Mermaid/DOT);
           - Designed for developers building workflows using FlowLite;