Skip to content

Update design

update design - Update existing workspace.dsl for a module using AI

Updates an existing Structurizr DSL workspace file for a module by analyzing its current source code using AI. The AI re-analyzes the source code in src// and updates the architecture documentation to reflect current state, preserving the overall structure while incorporating new components, relationships, or changes. All updated workspaces are automatically validated against Structurizr CLI to ensure correct syntax before saving. Use --debug to save intermediate outputs to out/commands.log for debugging.

Flags

Flag Description
-d, --debug (default: false) Save intermediate outputs (prompts, raw AI responses, validation results) to out/commands.log for debugging
-f, --force (default: false) Overwrite workspace.dsl even if validation fails
-o, --output Custom output path for workspace.dsl (default: specs//.design/workspace.dsl)
--prompt Custom AI prompt file path

Notes

Expected Output:

  • Updated Structurizr DSL workspace file at specs//.design/workspace.dsl
  • Preserves overall structure while incorporating code changes
  • Validated syntax (passed Structurizr CLI validation)

See Also


Tutorials | How-to Guides | Explanation | Reference

You are here: Reference — information-oriented technical descriptions of the system.