Automatic Module Grouping

Resources are automatically organized by Terraform module, making it easy to understand changes in complex multi-module configurations.

all providers

Large Terraform plans often contain hundreds of resources scattered across multiple modules. tfplan2md automatically groups these resources by their module path, providing a structured and hierarchical view of changes.

❌ Without tfplan2md

Raw Terraform Output 
# azurerm_resource_group.core will be created
+ resource "azurerm_resource_group" "core" {
    + id       = (known after apply)
    + location = "eastus"
    + name     = "rg-tfplan2md-demo"
  }

# module.network.azurerm_virtual_network.hub will be created
+ resource "azurerm_virtual_network" "hub" {
    + address_space       = ["10.0.0.0/16"]
    + id                  = (known after apply)
    + location            = "eastus"
    + name                = "vnet-hub"
  }

# module.security.azurerm_role_assignment.rg_reader will be created
+ resource "azurerm_role_assignment" "rg_reader" {
    + id                   = (known after apply)
    + principal_id         = "00000000-0000-0000-0000-000000000001"
    + principal_type       = "User"
    + role_definition_name = "Reader"
    + scope                = "/subscriptions/.../resourceGroups/rg-tfplan2md-demo"
  }

# module.network.azurerm_virtual_network.spoke will be created
+ resource "azurerm_virtual_network" "spoke" {
    + address_space       = ["10.1.0.0/16"]
    + id                  = (known after apply)
  }

Resources from different modules are intermixed—hard to see structure.

✅ With tfplan2md

Module-Grouped Output

📦 Module: root

➕ azurerm_resource_group core — 🆔 rg-tfplan2md-demo 🌍 eastus ...

📦 Module: module.network

➕ azurerm_virtual_network hub — 🆔 vnet-hub 🌐 10.0.0.0/16 ...
➕ azurerm_virtual_network spoke — 🆔 vnet-spoke 🌐 10.1.0.0/16 ...

📦 Module: module.security

➕ azurerm_role_assignment rg_reader — 👤 User → 🛡️ Reader on rg-tfplan2md-demo ... 
### 📦 Module: root

<details>
<summary>➕ azurerm_resource_group <b><code>core</code></b> — <code>🆔 rg-tfplan2md-demo</code> <code>🌍 eastus</code></summary>
...
</details>

---

### 📦 Module: `module.network`

<details>
<summary>➕ azurerm_virtual_network <b><code>hub</code></b> — <code>🆔 vnet-hub</code> <code>🌐 10.0.0.0/16</code></summary>
...
</details>

<details>
<summary>➕ azurerm_virtual_network <b><code>spoke</code></b> — <code>🆔 vnet-spoke</code> <code>🌐 10.1.0.0/16</code></summary>
...
</details>

---

### 📦 Module: `module.security`

<details>
<summary>➕ azurerm_role_assignment <b><code>rg_reader</code></b> — <code>👤 User</code> → <code>🛡️ Reader</code> on <code>rg-tfplan2md-demo</code></summary>
...
</details>

Clear module separation—each module's resources are grouped together.

Benefits

  • Root module appears first, followed by child modules in sorted order
  • Modules without changes are omitted for cleaner reports
  • Nested modules are shown flat but maintain hierarchical sort order
  • Enabled by default—no configuration required

Learn More

Module grouping is automatically applied to all reports, organizing resources by their Terraform module hierarchy.

Related Documentation