formulamonks / scaffoldizr

Opinionated TypeScript/Bun Scaffolding Tool for creating Structurizr DSL Documentations

Scaffoldizr: Scaffolding to create Structurizr Workspaces

Structurizr Workspaces are a great way to document and share architecture diagrams in the C4 model. However, the diagram creation is freeform and there are no guidelines to break code into files, leaving architects and developers with a feeling of not knowing where to start.

This is an opinionated scaffolding tool written in TypeScript/Bun that attempts to create the building blocks of a solid system architecture documentation, that accounts for newcomers as well as architects experienced in Structurizr, to allow them to follow a convention while setting them up for success.

Installation

Run in your terminal:

curl -s https://formulamonks.github.io/scaffoldizr/assets/install.sh | sh

Then, verify the tool is correctly installed:

scfz --version

Usage

scfz --dest {docs_folder}

where {docs_folder} is a folder where dsl files will be generated. The tool creates an architecture/ folder and starts scaffolding from there. {docs_folder} default value is current working directory. So you can just issue scfz command.

Full documentation here.

scaffoldizr's Issues

[BUG] Install script: marks the wrong version

Describe the bug
When running the installer, it gets the previous Scaffoldizr version.

To Reproduce
Steps to reproduce the behavior:

1. Wait for a new version to be released
2. Run the install script from this page.
3. Check scfz --version

Expected behavior
Version should reflect the latest version installed. It displays the wrong version.

Desktop (please complete the following information):

• OS: any
• Version: Welp...

[IDEA] Check latest version + update instructions

Is your feature request related to a problem? Please describe.
Once a new version is available, there's no notification for the user.

Describe the solution you'd like
Once a new version is available, present the user with a message to update, including extended instructions for update.