2. Create with local, view with local

  1. Create and edit workspaces on your computer using the Structurizr DSL and a text-editor/IDE, using local to view your diagrams and modify their layout - see step-by-step instructions.
  2. Store the workspace.dsl and workspace.json files in version control (e.g. git).
  3. Provide instructions for team members of where to access the workspace.dsl and workspace.json files, and how to start local so they can view/edit the diagrams too.

Rating

  • Workspace editing: (fast feedback loop, all Structurizr DSL features are available, workspaces are stored in version control)
  • Diagram viewing: (interactive diagrams, double-click to zoom, etc)

Benefits

  • Workspace editors can use the full set of Structurizr DSL features because the Structurizr DSL parser runs on their computer.
  • local provides the quickest feedback loop, especially when running your text editor/IDE and web browser split screen in conjunction with the auto-refresh option.
  • The workspace.dsl and workspace.json files can easily be stored in version control.
  • Doesn’t require the Structurizr server to be installed.

Considerations

  • Workspace editors require Docker or Java 21+ installed to run local.
  • Diagram viewers require Docker or Java 21+ installed to run local.
  • Diagram viewers require access to version control.