Commands

All the Structurizr commands listed below are free and open source except for server - this follows an open core model, with closed extensions for features that are designed for use in enterprise environments.

Command Description
playground Starts the Structurizr playground.
local Starts Structurizr local, which provides a way to view diagrams and modify their layout (the equivalent of Structurizr Lite).
server Starts a Structurizr server (the equivalent of the Structurizr on-premises installation).
export Exports the views in a Structurizr workspace to PlantUML, Mermaid, or a static HTML site.
push Pushes a workspace to a Structurizr server.
pull Pulls a workspace from a Structurizr server.
branches Lists the branches for a workspace.
delete Deletes a workspace branch.
lock Locks a workspace on a Structurizr server.
unlock Unlocks a workspace on a Structurizr server.
merge Merges the layout information into a workspace.
validate Validates a workspace.
inspect Runs the inspections on a workspace.
list Lists the elements in a workspace.
version Displays version information.
help Displays a help message.