Skip to content


Switch branches/tags


Structurizr command line interface (CLI)

This GitHub repository contains the Structurizr CLI - a command line utility for Structurizr, designed to be used in conjunction with the Structurizr DSL, and supports the following commands/functionality:

  • push content to the Structurizr cloud service/on-premises installation
  • pull workspace content as JSON
  • lock a workspace
  • unlock a workspace
  • export diagrams to PlantUML, Mermaid, WebSequenceDiagrams, DOT, and Ilograph; or a DSL workspace to JSON
  • list elements within a workspace
  • validate a JSON/DSL workspace definition

Getting started

See the getting started guide for details of how to download, install, and use the Structurizr CLI.