terraform-plan-summary 1.0.1

Summarize Terraform plan outputs.

terraform-plan-summary

A Python command-line tool that transforms Terraform plan outputs into clean, hierarchical tree views with color-coded changes. Easily visualize your infrastructure changes organized by modules with detailed attribute-level inspection.

Installation

From PyPI

Using uv:

uv pip install terraform-plan-summary

Or run directly with uvx:

uvx terraform-plan-summary

Requirements

• Python 3.13 or higher
• Terraform CLI (for processing binary plan files)

Usage

Basic Usage

# From a JSON plan file
terraform-plan-summary plan.json

# From a binary plan file (requires terraform CLI)
terraform-plan-summary plan.out

Command Line Options

terraform-plan-summary [OPTIONS] PLAN_FILE

Arguments:
  PLAN_FILE                 Path to Terraform plan file (binary .out or JSON)

Options:
  -v, --verbose             Show changed attributes (-v) or their values (-vv)
  --show-ids                Display resource identifiers (name, ARN, ID, etc.)
  -h, --help               Show help message

Examples

Basic Tree View

terraform-plan-summary plan.json

root_module
├── + aws_instance.web_server
├── ~ aws_security_group.web_sg
└── database
    ├── + aws_db_instance.main
    └── - aws_db_subnet_group.legacy

With Resource Identifiers

terraform-plan-summary --show-ids plan.json

root_module
├── + aws_instance.web_server (web-server-prod)
├── ~ aws_security_group.web_sg (sg-0abc123def456789)
└── database
    ├── + aws_db_instance.main (prod-database)
    └── - aws_db_subnet_group.legacy (legacy-subnet-group)

Detailed Attribute Changes

terraform-plan-summary -vv --show-ids plan.json

root_module
├── + aws_instance.web_server (web-server-prod)
├── ~ aws_security_group.web_sg (sg-0abc123def456789)
│   ├── ~ ingress: [] -> [{"cidr_blocks":["0.0.0.0/0"],"from_port":80,"protocol":"tcp","to_port":80}]
│   └── + name: "web-security-group"
└── database
    ├── + aws_db_instance.main (prod-database)
    └── - aws_db_subnet_group.legacy (legacy-subnet-group)
        └── - subnet_ids: ["subnet-abc123","subnet-def456"]

Generating Terraform Plans

JSON Format (Recommended)

terraform plan -out=plan.out
terraform show -json plan.out > plan.json
terraform-plan-summary plan.json

Binary Format

terraform plan -out=plan.out
terraform-plan-summary plan.out