### Structurizr Workspace DSL Example Source: https://context7.com/structurizr/cli/llms.txt Defines a software architecture model and views using the Structurizr DSL. Includes model elements like people and containers, relationships, and view configurations with autolayout and themes. ```dsl workspace { model { user = person "User" "A user of the system" softwareSystem = softwareSystem "Software System" "Main application" { webapp = container "Web Application" "Delivers content" "Java/Spring" database = container "Database" "Stores data" "PostgreSQL" !docs docs !adrs adrs } user -> webapp "Uses" webapp -> database "Reads/writes" } views { systemContext softwareSystem "SystemContext" { include * autolayout } container softwareSystem "Containers" { include * autolayout } theme default } } ``` -------------------------------- ### Push Workspace with Encryption and Archiving Source: https://context7.com/structurizr/cli/llms.txt Uploads a local workspace DSL file to an on-premises Structurizr installation with client-side encryption, merging layout, and archiving previous versions. Requires API key, secret, and passphrase. ```bash structurizr push \ -url https://structurizr.example.com/api \ -id 12345 \ -key your-api-key \ -secret your-api-secret \ -workspace workspace.dsl \ -passphrase "encryption-passphrase" \ -merge true \ -archive true ``` -------------------------------- ### Pull Workspace from On-Premises with Encryption Source: https://context7.com/structurizr/cli/llms.txt Downloads a workspace from an on-premises Structurizr installation with client-side encryption. Requires workspace ID, API key, secret, and passphrase. ```bash structurizr pull \ -url https://structurizr.example.com/api \ -id 12345 \ -key your-api-key \ -secret your-api-secret \ -passphrase "encryption-passphrase" ``` -------------------------------- ### Unlock Workspace Source: https://context7.com/structurizr/cli/llms.txt Unlocks a previously locked workspace on the Structurizr server. Requires workspace ID, API key, and secret. Supports on-premises installations via a URL flag. ```bash # Unlock a workspace structurizr unlock \ -id 12345 \ -key your-api-key \ -secret your-api-secret ``` ```bash # Unlock workspace on on-premises installation structurizr unlock \ -url https://structurizr.example.com/api \ -id 12345 \ -key your-api-key \ -secret your-api-secret ``` -------------------------------- ### Lock Workspace Source: https://context7.com/structurizr/cli/llms.txt Locks a workspace on the Structurizr server to prevent concurrent modifications. Requires workspace ID, API key, and secret. Supports on-premises installations via a URL flag. ```bash # Lock a workspace structurizr lock \ -id 12345 \ -key your-api-key \ -secret your-api-secret ``` ```bash # Lock workspace on on-premises installation structurizr lock \ -url https://structurizr.example.com/api \ -id 12345 \ -key your-api-key \ -secret your-api-secret ``` -------------------------------- ### Show Help Information Source: https://context7.com/structurizr/cli/llms.txt Displays usage information for all available Structurizr CLI commands. ```bash # Show help structurizr help ``` -------------------------------- ### Generate Static HTML Site Source: https://context7.com/structurizr/cli/llms.txt Generates a static HTML site from a local workspace DSL file, providing a browsable documentation of the architecture. ```bash structurizr export \ -workspace workspace.dsl \ -format static \ -output ./site ``` -------------------------------- ### Show CLI Version Source: https://context7.com/structurizr/cli/llms.txt Displays the current version of the Structurizr CLI. ```bash # Show CLI version structurizr version ``` -------------------------------- ### Inspect Workspace with Default Inspector Source: https://context7.com/structurizr/cli/llms.txt Runs architecture inspections on a local workspace DSL file using the default inspector to identify potential issues. ```bash structurizr inspect \ -workspace workspace.dsl ``` -------------------------------- ### Push Workspace to Structurizr Cloud Source: https://context7.com/structurizr/cli/llms.txt Uploads a local workspace DSL file to Structurizr cloud. Requires API key and secret. ```bash structurizr push \ -id 12345 \ -key your-api-key \ -secret your-api-secret \ -workspace workspace.dsl ``` -------------------------------- ### List Workspace Elements Source: https://context7.com/structurizr/cli/llms.txt Lists all elements in a workspace model hierarchically. Can process local DSL or JSON files, or remote DSL files via URL. ```bash # List all elements in a workspace structurizr list \ -workspace workspace.dsl ``` ```bash # List elements from a JSON workspace structurizr list \ -workspace workspace.json ``` ```bash # List elements from remote workspace structurizr list \ -workspace https://example.com/workspace.dsl ``` -------------------------------- ### Export Workspace to DOT (Graphviz) Source: https://context7.com/structurizr/cli/llms.txt Exports a local workspace JSON file to DOT format, compatible with Graphviz for generating diagrams. ```bash structurizr export \ -workspace workspace.json \ -format dot ``` -------------------------------- ### Inspect Workspace with Custom Inspector Source: https://context7.com/structurizr/cli/llms.txt Runs architecture inspections on a local workspace DSL file using a custom inspector implementation specified by its fully qualified class name. ```bash structurizr inspect \ -workspace workspace.dsl \ -inspector com.example.CustomInspector ``` -------------------------------- ### Pull Workspace from Structurizr Cloud Source: https://context7.com/structurizr/cli/llms.txt Downloads a workspace from Structurizr cloud and saves it as a JSON file locally. Requires workspace ID, API key, and secret. ```bash structurizr pull \ -id 12345 \ -key your-api-key \ -secret your-api-secret # Output: structurizr-12345-workspace.json ``` -------------------------------- ### Export Workspace to PlantUML Source: https://context7.com/structurizr/cli/llms.txt Exports a local workspace DSL file to PlantUML format. The output can be customized with different PlantUML flavors. ```bash structurizr export \ -workspace workspace.dsl \ -format plantuml ``` ```bash structurizr export \ -workspace workspace.dsl \ -format plantuml/c4plantuml \ -output ./diagrams ``` -------------------------------- ### Inspect Workspace with Specific Severity Levels Source: https://context7.com/structurizr/cli/llms.txt Runs architecture inspections on a local workspace DSL file, filtering results by specified error and warning severity levels. ```bash structurizr inspect \ -workspace workspace.dsl \ -severity "error,warning" ``` -------------------------------- ### Export Workspace from Remote URL Source: https://context7.com/structurizr/cli/llms.txt Exports a workspace directly from a remote URL (e.g., a DSL file hosted online) to PlantUML format. ```bash structurizr export \ -workspace https://example.com/workspace.dsl \ -format plantuml ``` -------------------------------- ### Export Workspace as JSON Source: https://context7.com/structurizr/cli/llms.txt Exports a local workspace DSL file into a JSON format, saving it to a specified output directory. Useful for further processing or backup. ```bash structurizr export \ -workspace workspace.dsl \ -format json \ -output ./output ``` -------------------------------- ### Export Workspace to Mermaid Source: https://context7.com/structurizr/cli/llms.txt Exports a local workspace DSL file to Mermaid format. This is useful for generating diagrams in Markdown environments. ```bash structurizr export \ -workspace workspace.dsl \ -format mermaid ``` -------------------------------- ### Export Workspace Theme Source: https://context7.com/structurizr/cli/llms.txt Exports the theme definition from a local workspace DSL file. This can be used to apply consistent styling across diagrams. ```bash structurizr export \ -workspace workspace.dsl \ -format theme ``` -------------------------------- ### Push Workspace to a Specific Branch Source: https://context7.com/structurizr/cli/llms.txt Uploads a local workspace JSON file to a specific branch on Structurizr cloud. Requires API key and secret. ```bash structurizr push \ -id 12345 \ -key your-api-key \ -secret your-api-secret \ -workspace workspace.json \ -branch feature-branch ``` -------------------------------- ### Merge Layout Information Source: https://context7.com/structurizr/cli/llms.txt Merges layout information from a JSON workspace file into a DSL workspace file, saving the result to a new JSON file. Useful for preserving diagram layouts. ```bash structurizr merge \ -workspace workspace.dsl \ -layout workspace-with-layout.json \ -output merged-workspace.json ``` -------------------------------- ### Validate Local DSL Workspace Source: https://context7.com/structurizr/cli/llms.txt Validates a local Structurizr workspace defined in DSL format for syntax and structural errors. ```bash structurizr validate \ -workspace workspace.dsl ``` -------------------------------- ### Merge Layout for Specific View Source: https://context7.com/structurizr/cli/llms.txt Merges layout information from a JSON file into a specific view of a workspace DSL file, outputting to a new JSON file. Useful for preserving manual layout adjustments. ```bash structurizr merge \ -workspace workspace.dsl \ -layout workspace-with-layout.json \ -view SystemContext \ -output merged-workspace.json ``` -------------------------------- ### Pull Specific Branch Workspace Source: https://context7.com/structurizr/cli/llms.txt Downloads a specific branch of a workspace from Structurizr cloud and saves it locally. Requires workspace ID, API key, secret, and branch name. ```bash structurizr pull \ -id 12345 \ -key your-api-key \ -secret your-api-secret \ -branch development # Output: structurizr-12345-development-workspace.json ``` -------------------------------- ### Validate Remote Workspace Source: https://context7.com/structurizr/cli/llms.txt Validates a Structurizr workspace directly from a remote URL for syntax and structural errors. ```bash structurizr validate \ -workspace https://example.com/workspace.dsl ``` -------------------------------- ### Validate Local JSON Workspace Source: https://context7.com/structurizr/cli/llms.txt Validates a local Structurizr workspace defined in JSON format for syntax and structural errors. ```bash structurizr validate \ -workspace workspace.json ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.