Skip to content

export.md

Latest commit

 

History

History
46 lines (30 loc) · 1.58 KB

export.md

File metadata and controls

46 lines (30 loc) · 1.58 KB
Raw

export

The export command allows you to export the views within a Structurizr workspace to a number of different formats. Files will be created one per view that has been exported. If output directory is not specified, files will be created in the same directory as the workspace.

Options

  • -workspace: The path or URL to the workspace JSON file/DSL file(s) (required)
  • -format: plantuml|mermaid|websequencediagrams|ilograph|json (required)
  • -output: Relative or absolute path to an output directory (optional)

The PlantUML export format can also be specified with a sub-format: plantuml/structurizr (default), plantuml/basic, and plantuml/c4plantuml.

Examples

To export all views in a JSON workspace to PlantUML format under folder named 'diagrams':

java -jar structurizr-cli-*.jar export -workspace myworkspace.json -format plantuml -output diagrams

To export all views in a JSON workspace to PlantUML format, using C4-PlantUML, under folder named 'diagrams':

java -jar structurizr-cli-*.jar export -workspace myworkspace.json -format plantuml/c4plantuml -output diagrams

To export all views in a JSON workspace to Mermaid format:

java -jar structurizr-cli-*.jar export -workspace myworkspace.json -format mermaid

To export all dynamic views in a DSL workspace to WebSequenceDiagrams format:

java -jar structurizr-cli-*.jar export -workspace myworkspace.dsl -format websequencediagrams

To export a DSL workspace to the JSON workspace format:

java -jar structurizr-cli-*.jar export -workspace myworkspace.dsl -format json