Crate graphs_tui 

graphs-tui - Terminal renderer for Mermaid and D2 diagrams

Mermaid Flowchart Example

use graphs_tui::{render_mermaid_to_tui, RenderOptions};

let input = "flowchart LR\nA[Start] --> B[End]";
let result = render_mermaid_to_tui(input, RenderOptions::default()).unwrap();
println!("{}", result.output);
for warning in &result.warnings {
    eprintln!("Warning: {warning}");
}

State Diagram Example

use graphs_tui::{render_state_diagram, RenderOptions};

let input = "stateDiagram-v2\n    [*] --> Idle\n    Idle --> Running";
let result = render_state_diagram(input, RenderOptions::default()).unwrap();
println!("{}", result.output);

Pie Chart Example

use graphs_tui::{render_pie_chart, RenderOptions};

let input = "pie\n    \"Chrome\" : 65\n    \"Firefox\" : 35";
let result = render_pie_chart(input, RenderOptions::default()).unwrap();
println!("{}", result.output);

D2 Example

use graphs_tui::{render_d2_to_tui, RenderOptions};

let input = "A -> B: connection";
let result = render_d2_to_tui(input, RenderOptions::default()).unwrap();
println!("{}", result.output);

Sequence Diagram Example

use graphs_tui::{render_sequence_diagram, RenderOptions};

let input = "sequenceDiagram\n    Alice->>Bob: Hello\n    Bob-->>Alice: Hi!";
let result = render_sequence_diagram(input, RenderOptions::default()).unwrap();
println!("{}", result.output);

Auto-detect Format

use graphs_tui::{render_diagram, RenderOptions};

let mermaid_input = "flowchart LR\nA --> B";
let d2_input = "A -> B";

// Automatically detects format
let _ = render_diagram(mermaid_input, RenderOptions::default());
let _ = render_diagram(d2_input, RenderOptions::default());

Structs

Edge

An edge connecting two nodes

Graph

The complete graph structure

Node

A node in the flowchart

RenderOptions

Options for rendering the diagram

RenderResult

Result of rendering a diagram

Subgraph

A subgraph/group of nodes

TableField

A field inside a sql_table or class node (D2)

Enums

DiagramFormat

Diagram format

DiagramWarning

Structured warning emitted during layout or rendering

Direction

Flow direction for the diagram

EdgeStyle

Style of an edge/link

MermaidError

Errors that can occur during mermaid parsing/rendering

NodeShape

Shape of a node

Constants

SUPPORTED_LANGUAGES

Languages supported by graphs-tui.

Functions

check

Validate diagram without rendering output.

compute_layout

Compute layout for all nodes in the graph

compute_layout_with_options

Compute layout for all nodes with render options (considers max_width)

detect_format

Detect the diagram format from input

is_supported

Check if a language string is supported for rendering.

render

Unified entry point — render a diagram by language name.

render_d2_to_tui

Render D2 diagram syntax to terminal-displayable text

render_diagram

Render diagram with auto-detection of format

render_mermaid_to_tui

Render mermaid flowchart syntax to terminal-displayable text

render_pie_chart

Render mermaid pie chart to terminal-displayable text

render_sequence_diagram

Render mermaid sequence diagram to terminal-displayable text

render_state_diagram

Render mermaid state diagram to terminal-displayable text

Type Aliases

NodeId

Node identifier type