# Choreo v0.14.1 - Table of Contents

> Domain-specific diagram builders and graph analyzers on top of Yog

## Pages

- [Lab DSL + Compose/View Cheatsheet](lab_cheatsheet.md)

- Getting Started
  - [Choreo](readme.md)
  - [Architecture & Design Modeling](architecture_and_design.md)
  - [Behavior & Flow Modeling](behavior_and_flows.md)
  - [Data & Structure Modeling](data_and_structure.md)
  - [Interactive Livebooks](livebooks.md)
  - [Lab DSLs and Sketch Syntax](lab_dsl.md)
  - [Choreo Analysis Algorithms Reference](algorithms.md)

- Resources
  - [Changelog](changelog.md)

## Modules

- [Choreo.DOT](Choreo.DOT.md): Renders a structured diagram module into a Graphviz DOT string representation.

- [Choreo.Lab.DSL.Compiler](Choreo.Lab.DSL.Compiler.md): Shared helper functions for Choreo Lab DSL compilers.
- [Choreo.Livebook](Choreo.Livebook.md): Shared helpers for parsing and headlessly evaluating Choreo Livebooks.
- [Choreo.MCP](Choreo.MCP.md): A lightweight MCP (Model Context Protocol) server implementation.
Exposes system design capabilities to LLM clients via stdio transport.
- [Choreo.Render.Architecture](Choreo.Render.Architecture.md): Renders a `Choreo` struct to Mermaid.js `architecture-beta` syntax.
- [Choreo.Requirement](Choreo.Requirement.md): Requirements traceability diagram builder on top of Yog.
- [Choreo.Requirement.Analysis](Choreo.Requirement.Analysis.md): Analysis algorithms for `Choreo.Requirement` diagrams.
- [Choreo.Requirement.Render.DOT](Choreo.Requirement.Render.DOT.md): Graphviz DOT rendering for `Choreo.Requirement` diagrams.
- [Choreo.Requirement.Render.Mermaid](Choreo.Requirement.Render.Mermaid.md): Mermaid.js rendering for `Choreo.Requirement` diagrams.
- [Choreo.Sequence.Render.DOT](Choreo.Sequence.Render.DOT.md): Best-effort DOT renderer for `Choreo.Sequence`.
- [Choreo.Sequence.Render.Mermaid](Choreo.Sequence.Render.Mermaid.md): Mermaid `sequenceDiagram` renderer for `Choreo.Sequence`.
- [Choreo.ThreatModel.Analysis.Rule](Choreo.ThreatModel.Analysis.Rule.md): Extensible callback protocols for defining organizational custom threat metrics.

- Core
  - [Choreo](Choreo.md): A domain-specific layer on top of Yog for modeling system architectures.
  - [Choreo.Domain](Choreo.Domain.md): Domain-Driven Design (DDD) and Event Storming domain-modeling preset for Choreo.
  - [Choreo.Mermaid](Choreo.Mermaid.md): Renders a structured diagram module into a Mermaid.js string representation.
  - [Choreo.Sequence](Choreo.Sequence.md): Sequence diagrams for Choreo.
  - [Choreo.Theme](Choreo.Theme.md): Visual themes for `Choreo` architecture diagrams.
  - [Choreo.View](Choreo.View.md): Graph lenses — zoom, focus, and filter any Choreo diagram.
  - [Choreo.Viewable](Choreo.Viewable.md): Protocol for graph lens transforms (focus, zoom, filter, collapse) on Choreo diagrams.

- System Architecture
  - [Choreo.C4](Choreo.C4.md): C4 Model architecture diagram builder on top of Yog.
  - [Choreo.C4.Render.DOT](Choreo.C4.Render.DOT.md): DOT (Graphviz) rendering for `Choreo.C4` architecture diagrams.
  - [Choreo.C4.Render.Mermaid](Choreo.C4.Render.Mermaid.md): Mermaid.js rendering for `Choreo.C4` architecture diagrams.
  - [Choreo.Render.DOT](Choreo.Render.DOT.md): DOT (Graphviz) rendering for `Choreo` architecture diagrams.
  - [Choreo.Render.Mermaid](Choreo.Render.Mermaid.md): Mermaid.js rendering for `Choreo` architecture diagrams.

- Cloud Infrastructure
  - [Choreo.Infrastructure](Choreo.Infrastructure.md): Cloud network and infrastructure topology preset built on top of Choreo's rendering primitives.

- State Machines
  - [Choreo.FSM](Choreo.FSM.md): Finite-state machine builder on top of Yog.
  - [Choreo.FSM.Render.DOT](Choreo.FSM.Render.DOT.md): DOT (Graphviz) rendering for `Choreo.FSM` state-machine diagrams.
  - [Choreo.FSM.Render.Mermaid](Choreo.FSM.Render.Mermaid.md): Mermaid.js rendering for `Choreo.FSM` state-machine diagrams.

- Dataflow & Pipelines
  - [Choreo.Dataflow](Choreo.Dataflow.md): Dataflow / pipeline diagram builder on top of Yog.
  - [Choreo.Dataflow.Render.DOT](Choreo.Dataflow.Render.DOT.md): DOT (Graphviz) rendering for `Choreo.Dataflow` pipeline diagrams.
  - [Choreo.Dataflow.Render.Mermaid](Choreo.Dataflow.Render.Mermaid.md): Mermaid.js rendering for `Choreo.Dataflow` pipeline diagrams.

- Dependency Graphs
  - [Choreo.Dependency](Choreo.Dependency.md): Software dependency graph builder on top of Yog.
  - [Choreo.Dependency.Render.DOT](Choreo.Dependency.Render.DOT.md): DOT (Graphviz) rendering for `Choreo.Dependency` graphs.
  - [Choreo.Dependency.Render.Mermaid](Choreo.Dependency.Render.Mermaid.md): Mermaid.js rendering for `Choreo.Dependency` graphs.

- Decision Trees
  - [Choreo.DecisionTree](Choreo.DecisionTree.md): Decision-tree builder on top of Yog.
  - [Choreo.DecisionTree.Render.DOT](Choreo.DecisionTree.Render.DOT.md): DOT (Graphviz) rendering for `Choreo.DecisionTree`.
  - [Choreo.DecisionTree.Render.Mermaid](Choreo.DecisionTree.Render.Mermaid.md): Mermaid.js rendering for `Choreo.DecisionTree`.

- Threat Modeling
  - [Choreo.ThreatModel](Choreo.ThreatModel.md): STRIDE threat-modeling builder on top of Yog.
  - [Choreo.ThreatModel.Render.DOT](Choreo.ThreatModel.Render.DOT.md): DOT (Graphviz) rendering for `Choreo.ThreatModel`.
  - [Choreo.ThreatModel.Render.Mermaid](Choreo.ThreatModel.Render.Mermaid.md): Mermaid.js rendering for `Choreo.ThreatModel` graphs.
  - [Choreo.ThreatModel.Render.PlantUML](Choreo.ThreatModel.Render.PlantUML.md): Generates PlantUML sequence diagrams from data flows.

- Workflow & Orchestration
  - [Choreo.Workflow](Choreo.Workflow.md): Workflow / task orchestration diagram builder on top of Yog.
  - [Choreo.Workflow.Render.DOT](Choreo.Workflow.Render.DOT.md): DOT (Graphviz) rendering for `Choreo.Workflow` orchestration diagrams.
  - [Choreo.Workflow.Render.Mermaid](Choreo.Workflow.Render.Mermaid.md): Mermaid.js rendering for `Choreo.Workflow` orchestration diagrams.

- Planning & Task Management
  - [Choreo.Planner](Choreo.Planner.md): Project planning and task management diagram builder on top of Yog.
  - [Choreo.Planner.Analysis](Choreo.Planner.Analysis.md): Graph analysis algorithms for `Choreo.Planner` projects.
  - [Choreo.Planner.Render.DOT](Choreo.Planner.Render.DOT.md): DOT (Graphviz) rendering for `Choreo.Planner` dependency networks.
  - [Choreo.Planner.Render.Mermaid](Choreo.Planner.Render.Mermaid.md): Mermaid.js rendering for `Choreo.Planner` project diagrams.

- Mind Maps
  - [Choreo.MindMap](Choreo.MindMap.md): Mind-map builder on top of Yog.
  - [Choreo.MindMap.Render.DOT](Choreo.MindMap.Render.DOT.md): DOT (Graphviz) rendering for `Choreo.MindMap`.
  - [Choreo.MindMap.Render.Mermaid](Choreo.MindMap.Render.Mermaid.md): Mermaid.js rendering for `Choreo.MindMap` diagrams.

- Database Design
  - [Choreo.ERD](Choreo.ERD.md): Entity-Relationship Diagram (ERD) builder on top of Yog.
  - [Choreo.ERD.Render.DOT](Choreo.ERD.Render.DOT.md): DOT (Graphviz) rendering for `Choreo.ERD` diagrams using HTML-like table nodes.

  - [Choreo.ERD.Render.Mermaid](Choreo.ERD.Render.Mermaid.md): Mermaid.js native `erDiagram` renderer for `Choreo.ERD`.

- UML Design
  - [Choreo.UML](Choreo.UML.md): UML Class and Struct Diagram builder on top of Yog.
  - [Choreo.UML.Render.DOT](Choreo.UML.Render.DOT.md): DOT (Graphviz) rendering for `Choreo.UML` diagrams using 3-compartment HTML record table nodes.

  - [Choreo.UML.Render.Mermaid](Choreo.UML.Render.Mermaid.md): Mermaid.js rendering for `Choreo.UML` diagrams, supporting flowchart & classDiagram syntaxes.

- Lab
  - [Choreo.Lab.Compose](Choreo.Lab.Compose.md): Pipe-friendly composition helpers for assembling Choreo models in Livebook.
  - [Choreo.Lab.DSL.C4](Choreo.Lab.DSL.C4.md): Experimental Livebook-friendly DSL for sketching C4 models.
  - [Choreo.Lab.DSL.Dataflow](Choreo.Lab.DSL.Dataflow.md): Experimental Livebook-friendly DSL for sketching dataflow pipelines.
  - [Choreo.Lab.DSL.DecisionTree](Choreo.Lab.DSL.DecisionTree.md): Experimental Livebook-friendly DSL for sketching decision trees.
  - [Choreo.Lab.DSL.Dependency](Choreo.Lab.DSL.Dependency.md): Experimental Livebook-friendly DSL for sketching software dependency graphs.
  - [Choreo.Lab.DSL.Domain](Choreo.Lab.DSL.Domain.md): Experimental Livebook-friendly DSL for sketching DDD domain models.
  - [Choreo.Lab.DSL.ERD](Choreo.Lab.DSL.ERD.md): Experimental Livebook-friendly DSL for sketching entity-relationship diagrams.
  - [Choreo.Lab.DSL.FSM](Choreo.Lab.DSL.FSM.md): Experimental Livebook-friendly DSL for sketching finite-state machines.
  - [Choreo.Lab.DSL.Infrastructure](Choreo.Lab.DSL.Infrastructure.md): Experimental Livebook-friendly DSL for sketching infrastructure diagrams.
  - [Choreo.Lab.DSL.MindMap](Choreo.Lab.DSL.MindMap.md): Experimental Livebook-friendly DSL for sketching mind maps.
  - [Choreo.Lab.DSL.Planner](Choreo.Lab.DSL.Planner.md): Experimental Livebook-friendly DSL for sketching project plans.
  - [Choreo.Lab.DSL.Requirement](Choreo.Lab.DSL.Requirement.md): Experimental Livebook-friendly DSL for sketching requirements traceability models.
  - [Choreo.Lab.DSL.Sequence](Choreo.Lab.DSL.Sequence.md): Experimental Livebook-friendly DSL for sketching sequence diagrams.
  - [Choreo.Lab.DSL.ThreatModel](Choreo.Lab.DSL.ThreatModel.md): Experimental Livebook-friendly DSL for sketching STRIDE threat models.
  - [Choreo.Lab.DSL.UML](Choreo.Lab.DSL.UML.md): Experimental Livebook-friendly DSL for sketching UML class diagrams.
  - [Choreo.Lab.DSL.Workflow](Choreo.Lab.DSL.Workflow.md): Experimental Livebook-friendly DSL for sketching workflows.
  - [Choreo.Lab.Siren](Choreo.Lab.Siren.md): A custom Kino widget for rendering Mermaid diagrams with pan, zoom, and height control.
  - [Choreo.Lab.Sketch](Choreo.Lab.Sketch.md): A custom Kino widget that renders Mermaid diagrams inside an interactive Excalidraw whiteboard.
  - [Choreo.Lab.View](Choreo.Lab.View.md): Pipe-friendly view helpers for exploring Choreo models in Livebook.

- Analysis
  - [Choreo.Analysis](Choreo.Analysis.md): Graph-algorithm wrappers for `Choreo` architecture diagrams.
  - [Choreo.Analysis.Tracing](Choreo.Analysis.Tracing.md): Analysis functions for cross-diagram semantic tracing in Choreo.

  - [Choreo.C4.Analysis](Choreo.C4.Analysis.md): Analysis functions for `Choreo.C4` architecture models.
  - [Choreo.Dataflow.Analysis](Choreo.Dataflow.Analysis.md): Analysis functions for `Choreo.Dataflow` pipelines.
  - [Choreo.DecisionTree.Analysis](Choreo.DecisionTree.Analysis.md): Analysis functions for `Choreo.DecisionTree`.
  - [Choreo.Dependency.Analysis](Choreo.Dependency.Analysis.md): Analysis functions for `Choreo.Dependency` graphs.
  - [Choreo.Domain.Analysis](Choreo.Domain.Analysis.md): Audit and analysis rules for `Choreo.Domain` diagrams.
  - [Choreo.ERD.Analysis](Choreo.ERD.Analysis.md): Analysis and topological query functions for `Choreo.ERD`.
  - [Choreo.FSM.Analysis](Choreo.FSM.Analysis.md): Analysis functions for `Choreo.FSM` state machines.
  - [Choreo.Infrastructure.Analysis](Choreo.Infrastructure.Analysis.md): Architectural analysis and security audits for `Choreo.Infrastructure`.
  - [Choreo.MindMap.Analysis](Choreo.MindMap.Analysis.md): Analysis functions for `Choreo.MindMap`.
  - [Choreo.Sequence.Analysis](Choreo.Sequence.Analysis.md): Analysis helpers for `Choreo.Sequence` diagrams.

  - [Choreo.ThreatModel.Analysis](Choreo.ThreatModel.Analysis.md): STRIDE threat analysis for `Choreo.ThreatModel`.
  - [Choreo.UML.Analysis](Choreo.UML.Analysis.md): Architectural analysis suite for `Choreo.UML` class/struct diagrams.
  - [Choreo.Workflow.Analysis](Choreo.Workflow.Analysis.md): Analysis functions for `Choreo.Workflow` orchestration diagrams.

## Mix Tasks

- [mix choreo.mcp](Mix.Tasks.Choreo.Mcp.md): Starts the lightweight, zero-dependency MCP stdio server for Choreo.
- [mix choreo.render](Mix.Tasks.Choreo.Render.md): Renders Choreo models from an `.exs` file into Mermaid (`.mmd`) or Graphviz DOT (`.dot`) artifacts.
- [mix choreo.test_livebooks](Mix.Tasks.Choreo.TestLivebooks.md): Finds and runs all Elixir code blocks inside the `.livemd` files under the `livebooks/` directory.
Ensures that the notebooks execute successfully without any runtime compilation or execution errors.