Skip to content

Viewing Architecture Diagrams

Home › Reference › R2R Eac › Viewing Architecture

All modules include C4 architecture diagrams defined in Structurizr DSL format.

Quick Start

# Start the Structurizr Lite server
r2r eac serve-design

# Open browser to http://localhost:8080

The server starts a Docker container running Structurizr Lite, which renders all workspace.dsl files from the repository.

Available Module Designs

Each module maintains its architecture diagrams in specs/[module]/.design/workspace.dsl:

Module Design Location Description
eac-commands specs/eac-commands/.design/ Command implementations with AI integration
eac-core specs/eac-core/.design/ Core domain libraries (contracts, repository, git)
eac-mcp-commands specs/eac-mcp-commands/.design/ MCP server for LLM tool integration
r2r-cli specs/r2r-cli/.design/ CLI application structure
ext-eac specs/ext-eac/.design/ Docker extension container
docs specs/docs/.design/ Documentation site architecture

Full list: Check specs/*/​.design/ directories in the repository.

Diagram Levels (C4 Model)

Each module provides multiple diagram levels following the C4 model:

  1. System Context - How the module fits in the overall system
  2. Container - Components within the module
  3. Component - Internal structure and relationships
  4. Code - Implementation details (when applicable)

Not all modules include all levels - it depends on complexity.

Working with Diagrams

View All Modules

The serve-design command automatically loads all workspace.dsl files:

r2r eac serve-design

Navigate between modules using the workspace dropdown in Structurizr Lite.

View Specific Module

  1. Run r2r eac serve-design
  2. Open http://localhost:8080
  3. Select module from workspace dropdown (top-left)
  4. Select diagram from the list

Export Diagrams

In Structurizr Lite:

  1. Click on a diagram
  2. Use export controls to download as PNG or SVG
  3. Diagrams maintain C4 model styling

Structurizr DSL Files

All diagrams are defined in workspace.dsl files using Structurizr DSL.

Format: Plain text DSL (easy to version control)

Example structure:

specs/
  eac-commands/
    .design/
      workspace.dsl          # Architecture definition
      .structurizr/          # Generated cache (not in git)

Documentation: Structurizr DSL Language Reference

Updating Diagrams

AI-Generated Updates

r2r eac update-design <module-name>

Uses AI to analyze code and update the workspace.dsl file.

Manual Editing

  1. Edit specs/<module>/.design/workspace.dsl
  2. Save changes
  3. Refresh browser - Structurizr Lite auto-reloads

Validate Syntax

r2r eac validate-design

Checks all workspace.dsl files for syntax errors using Structurizr CLI.

Creating New Diagrams

For new modules:

r2r eac create-design <module-name>

Generates a workspace.dsl file based on code analysis.

Tips

Auto-refresh - Structurizr Lite watches for file changes and reloads automatically

Navigation - Use the left sidebar to switch between workspaces (modules) and diagrams

Zoom - Use mouse wheel or diagram controls for zoom

Themes - Diagrams use consistent C4 model styling defined in workspace.dsl

Docker Required - The serve-design command requires Docker to run Structurizr Lite container

Common Diagram Types

eac-commands Module

  • System Context - Commands in the R2R/EAC ecosystem
  • Containers - Command implementation structure
  • DevelopmentCommands - AI-powered code generation commands
  • ExecutionCommands - Build, test, and pipeline execution
  • InfrastructureCommands - Security scanning and validation

eac-core Module

  • System Context - Core libraries role
  • Containers - Package organization
  • Component - Internal library structure

r2r-cli Module

  • System Context - CLI in the broader ecosystem
  • Containers - Application components
  • Component - Command routing and execution

Troubleshooting

Server won't start:

  • Check Docker is running
  • Check port 8080 is available
  • Run docker ps to see if container is already running

Diagrams not appearing:

  • Check workspace.dsl syntax with r2r eac validate-design
  • Look for error messages in browser console
  • Verify .design folder contains workspace.dsl

Changes not visible:

  • Hard refresh browser (Ctrl+F5 / Cmd+Shift+R)
  • Restart serve-design command
  • Check file was saved

Tutorials | How-to Guides | Explanation | Reference

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