Structurizr command line interface (CLI)

This GitHub repository contains the Structurizr CLI - a command line utility for Structurizr, and supports the following functionality:

• Push content to a Structurizr workspace (the cloud service or an on-premises installation)
  • A model and views defined using the Structurizr DSL
  • Markdown/AsciiDoc documentation
  • Architecture Decision Records (ADRs)
• Pull workspace content as JSON
• Export diagrams to PlantUML, Mermaid, WebSequenceDiagrams, and Ilograph

This repository is supported by Structurizr Limited, as a part of the Structurizr service.

Prerequisites

• You must have Java 8 or above installed, and available to use on your command line (please note that the CLI does not work with Java versions 11.0.0-11.0.3).
• Build the tool from the source (gradlew build), or download the prebuilt structurizr-cli ZIP file.
• To use the push and pull commands, you need a Structurizr workspace, and the following information from your dashboard (see Help - Workspaces for details):
  • Workspace ID
  • API key
  • API secret

Getting started

For a quick tutorial, see the getting started guide.

Usage

On the command line, in the same directory where you've placed the JAR file:

macOS/Linux

./structurizr.sh <command> [options]

Windows

structurizr <command> [options]

Supported commands are:

• push
• pull
• export

The Structurizr CLI will create some default views and styles for you if you don't define them yourself. See Defaults for more details.