structurizr-cli-docker

This docker container allows you to run structurizr-cli, a command line utility for Structurizr that lets you create software architecture models based upon the C4 model using a textual domain specific language (DSL).

Usage

# Make alias for cli command
alias str="docker run --rm -v '${PWD}':/root/data -w /root/data ghcr.io/aidmax/structurizr-cli-docker"

# Load your credentials (see example in .env.sample)
source .env

# Check syntax
str validate -workspace workspace.dsl

# Push diagrams to structurizr web service
str push -id $STR_ID -key $STR_API_KEY -secret $STR_API_SECRET -workspace your_workspace_file.dsl

GitHub Action

There is also a GitHub Action based on this repo you can use for automation.

Refer to GitHub Marketplace or repo

License

The Dockerfile and documentation in this project are released under the MIT.

Credits

The Dockerfile and documentation have been created by Maksim Milykh.