sirene
sirene is a local WYSIWYG editor and viewer for Mermaid, PlantUML, and Graphviz DOT diagrams, with SVG, PNG, and terminal ASCII output. It is one Rust binary, and renders offline without a browser, Node, or Java.
$ printf 'flowchart LR\n A[Start] --> B{Ok?} -->|yes| C[Done]\n' | sirene ascii
┌───────┐ ╱─────╲ ┌──────┐
│ Start ├───►│ Ok? ├──yes─►│ Done │
└───────┘ ╲─────╱ └──────┘
sirene FILEopens an editor window: the source on the left, a live drawing on the right. Edits on either side are written to the source as ordinary text edits.sirene svg,sirene png, andsirene asciirender a diagram file, a Markdown file’s diagram blocks, or stdin without opening a window, and can watch files for changes.svgandpngalso render directories of diagrams and watch for new files.- The parser keeps every byte of the source, so the editor never reformats a file. Diagnostics point at a line and column, and a diagram with errors is still drawn.
Diagrams
Mermaid:
- Flowcharts (
flowchartandgraph), swimlane diagrams (swimlane-beta), and agentflow diagrams (agentflow-beta) - Sequence diagrams (
sequenceDiagram) and ZenUML diagrams (zenuml) - State diagrams (
stateDiagram-v2), class diagrams (classDiagram), ER diagrams (erDiagram), requirement diagrams (requirementDiagram), and use case diagrams (usecase-beta) - Block diagrams (
block-beta), architecture diagrams (architecture-beta), and C4 diagrams (C4Contextand the other C4 types) - Git graphs (
gitGraph), timelines (timeline), gantt charts (gantt), and event modeling diagrams (eventmodeling) - Pie charts (
pie), XY charts (xychart-beta), quadrant charts (quadrantChart), radar charts (radar-beta), sankey diagrams (sankey-beta), treemaps (treemap-beta), and venn diagrams (venn-beta) - Mindmaps (
mindmap), tree views (treeView-beta), ishikawa diagrams (ishikawa-beta), kanban boards (kanban), user journeys (journey), Wardley maps (wardley-beta), and Cynefin diagrams (cynefin-beta) - Packet diagrams (
packet), railroad diagrams (railroad-ebnf-betaand the other notations), and info diagrams (info)
Other Mermaid diagram types are reported as unsupported. See Supported syntax for what is read and how it differs from Mermaid.
PlantUML (@startuml and the other @start kinds): sequence, activity, class,
object, state, use case, component, deployment, timing, network, mindmap, WBS, gantt, JSON,
YAML, EBNF, regular expression, Chen ER, chronology, and file tree diagrams.
Graphviz DOT (digraph and graph): records, HTML table labels, clusters, and ports.
Start with Install and the Quickstart.