Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

structurizrx render

Export diagrams from a workspace file to disk.

structurizrx render <file> [--format <fmt>] [--output <dir>]
FlagDefaultEffect
--formatplantumlOne of svg, png, mermaid, plantuml, dot/graphviz
--output, -o.Output directory (created if missing)

render first materializes generated (auto) views — the same step serve performs — so auto, auto focus, auto lint, etc. in the views block are expanded before export. Each diagram is written as <output>/<view-key>.<extension>.

Not every exporter supports every view type; unsupported views are skipped with a warning rather than silently vanishing:

FormatRenders
svgsystem landscape, system context, container, component
pngsame views as svg
mermaidsystem landscape, system context, container, component
dot/graphvizsystem landscape, system context
plantuml (default)system landscape, system context, container
structurizrx render ws.dsl --format svg --output ./out
Generated views: systemlandscape, systemcontext-shop, container-shop
Written: ./out/systemlandscape.svg
Written: ./out/systemcontext-shop.svg
Written: ./out/container-shop.svg
Warning: 1 view(s) skipped (svg exporter does not support: 1 dynamic)

PNG

--format png rasterizes the same SVG the svg exporter produces, using system fonts (via resvg) — there’s no separate PNG layout engine, so a diagram looks identical in both formats, just as pixels instead of vectors:

structurizrx render shop.dsl --format png --output ./out
Generated views: auto-landscape, auto-context-shop, auto-container-shop, auto-focus-api, auto-lint
Written: out/auto-landscape.png
Written: out/auto-focus-api.png
Written: out/auto-lint.png
Written: out/auto-context-shop.png
Written: out/auto-container-shop.png