# terramate-io/terramate architecture

> Architecture diagram of the GitHub repository terramate-io/terramate, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/terramate-io/terramate
- Repository: https://github.com/terramate-io/terramate

## Overview

##### Main Components

a) Core Engine Components:
- HCL Processing (/hcl directory)
- Stack Management (/stack directory)
- Code Generation (/generate directory)
- Run Orchestration (/run directory)
- Cloud Integration (/cloud directory)

b) CLI Interface:
- Command Processing (/cmd/terramate/cli)
- Output Handling (/cmd/terramate/cli/out)
- Configuration Management (/cmd/terramate/cli/cliconfig)

c) VCS Integration:
- GitHub Integration (/cmd/terramate/cli/github)
- GitLab Integration (/cmd/terramate/cli/gitlab)
- BitBucket Integration (/cmd/terramate/cli/bitbucket)

##### Interaction Flows
Following key interactions:

a) Primary Flow:
**User Input -> CLI Interface -> Stack Manager -> Orchestration Engine -> Infrastructure Providers**

b) Code Generation Flow:
**Stack Configuration -> Generator -> HCL/JSON/YAML Output -> Infrastructure Code**

##### Component Details

Specific elements:

a) Core Engine:

- Terramate Core    |

- Stack Management    |
- Code Generation     |
- Change Detection    |
- Orchestration       |

b) Integration Layer:

- Integration Layer     |

- Terraform           |
- OpenTofu            |
- Terragrunt          |
- VCS Systems         |

##### Key Relationships

Critical relationships:

- Stack Dependencies (using DAG representation)
- Code Generation Flow
- Change Detection Paths
- Cloud Integration Points

##### Additional Elements

Include:

- Version control integration points
- Cloud service connection points
- State management flow

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph User
        UI[User Input]
    end

    subgraph "CLI Layer"
        CLI[CLI Interface]:::cli
        OutHandler[Output Handler]:::cli
        ConfigMgr[Configuration Manager]:::cli
    end

    subgraph "Core Engine"
        HCL[HCL Processing]:::core
        Stack[Stack Management]:::core
        CodeGen[Code Generation]:::core
        RunOrch[Run Orchestration]:::core
        Cloud[Cloud Integration]:::core
        ChangeDet[Change Detection]:::core
        GenPipe[Code Generation Pipeline]:::core
        HCLGen[HCL Generation]:::core
        StackOrch[Stack Orchestration]:::core
        ResMgr[Resource Management]:::core
        CloudTest[Cloud Test Server]:::core
    end

    subgraph "VCS Integration"
        GitHub[GitHub]:::vcs
        GitLab[GitLab]:::vcs
        BitBucket[BitBucket]:::vcs
    end

    subgraph "Infrastructure Providers"
        Terraform[Terraform]:::infra
        OpenTofu[OpenTofu]:::infra
        Terragrunt[Terragrunt]:::infra
    end

    UI --> CLI
    CLI --> OutHandler
    CLI --> ConfigMgr
    
    CLI --> Stack
    Stack --> ChangeDet
    Stack --> CodeGen
    CodeGen --> GenPipe
    GenPipe --> HCLGen
    HCLGen --> HCL
    
    Stack --> RunOrch
    RunOrch --> StackOrch
    StackOrch --> ResMgr
    
    RunOrch --> Cloud
    Cloud --> CloudTest
    
    Stack --> GitHub
    Stack --> GitLab
    Stack --> BitBucket
    
    Cloud --> Terraform
    Cloud --> OpenTofu
    Cloud --> Terragrunt

    %% Click events for component mapping
    click HCL "https://github.com/terramate-io/terramate/tree/main//hcl"
    click Stack "https://github.com/terramate-io/terramate/tree/main//stack"
    click CodeGen "https://github.com/terramate-io/terramate/tree/main//generate"
    click RunOrch "https://github.com/terramate-io/terramate/tree/main//run"
    click Cloud "https://github.com/terramate-io/terramate/tree/main//cloud"
    click CLI "https://github.com/terramate-io/terramate/tree/main//cmd/terramate/cli"
    click OutHandler "https://github.com/terramate-io/terramate/tree/main//cmd/terramate/cli/out"
    click ConfigMgr "https://github.com/terramate-io/terramate/tree/main//cmd/terramate/cli/cliconfig"
    click GitHub "https://github.com/terramate-io/terramate/tree/main//cmd/terramate/cli/github"
    click GitLab "https://github.com/terramate-io/terramate/tree/main//cmd/terramate/cli/gitlab"
    click BitBucket "https://github.com/terramate-io/terramate/tree/main//cmd/terramate/cli/bitbucket"
    click ChangeDet "https://github.com/terramate-io/terramate/tree/main//stack/trigger"
    click GenPipe "https://github.com/terramate-io/terramate/tree/main//generate/genfile"
    click HCLGen "https://github.com/terramate-io/terramate/tree/main//generate/genhcl"
    click CloudTest "https://github.com/terramate-io/terramate/tree/main//cloud/testserver"
    click StackOrch "https://github.com/terramate-io/terramate/tree/main//scheduler"
    click ResMgr "https://github.com/terramate-io/terramate/tree/main//scheduler/resource"

    %% Styling
    classDef core fill:#2374ab
    classDef cli fill:#ff7f50
    classDef vcs fill:#48a9a6
    classDef infra fill:#9b4dca

    %% Legend
    subgraph Legend
        L1[Core Components]:::core
        L2[CLI Components]:::cli
        L3[VCS Integration]:::vcs
        L4[Infrastructure]:::infra
    end
```
