Validate design
validate design - Check workspace.dsl syntax using Structurizr CLI (requires Docker)
Validates DSL files for syntax errors and structural issues using the official Structurizr CLI running in Docker. Checks DSL syntax, element relationships, view definitions, and ensures the workspace can be properly rendered. Supports multiple DSL files per module - files starting with "_" are treated as fragments (for !include) and skipped. Use --all to validate all modules, or --file to validate a specific DSL file.
Flags
| Flag | Description |
|---|---|
-a, --all (default: false) |
Validate all workspace files in specs/*/.design/ directories |
-f, --file (default: "") |
Validate only a specific DSL file (e.g., --file=landscape) |
-d, --debug (default: false) |
Save intermediate outputs and detailed logs to out/logs/design/ for debugging |
-v, --verbose (default: false) |
Show Docker command and raw Structurizr CLI output |
Notes
Expected Output:
Displays validation results in console. Results saved to out/logs/design/validation-results.json. Shows syntax errors, structural issues, and render status. Exit code 0 if valid, 1 if errors, 2 if system errors.
See Also
Tutorials | How-to Guides | Explanation | Reference
You are here: Reference — information-oriented technical descriptions of the system.