tfreadme 0.1.0

Generate Markdown reports from Terraform plans

Terraform Plan Report Generator

Generate clean, human-readable Markdown reports from Terraform plan files.

This utility converts the output of terraform show -json into a structured Markdown report that is easier to review during infrastructure changes, pull requests, and CI/CD pipelines.

Features

• Generate Markdown reports from Terraform plan files

• Summary of resource actions

  • CREATE
  • UPDATE
  • DELETE
  • REPLACE

• Resource type summary

• Friendly resource name detection

• Resource ID extraction

• Terraform resource address listing

• Collapsible sections for improved readability

• Lightweight and dependency-minimal

Example Workflow

terraform plan -out=tfplan
              │
              ▼
terraform show -json tfplan
              │
              ▼
     Terraform Plan Report
              │
              ▼
      README_TFPLAN.md

Installation

Clone the repository:

git clone https://github.com/<your-username>/tfplan-report.git
cd tfplan-report

Install the package:

pip install .

Or install the dependency manually:

pip install tabulate

Requirements

• Python 3.9+
• Terraform CLI
• tabulate

Usage

Generate a Terraform plan:

terraform plan -out=tfplan

Generate the Markdown report:

tfreadme tfplan

or

python tfreadme.py tfplan

The tool generates:

README_TFPLAN.md

Sample Output

Plan Summary

Action	Count
CREATE	12
UPDATE	5
DELETE	2
REPLACE	1

Resource Type Summary

Resource Type	Count
aws_instance	8
aws_security_group	4
aws_iam_role	2

CREATE

Name	Type	Resource ID	Terraform Address
web-server	aws_instance	N/A	aws_instance.web

Project Structure

.
├── pyproject.toml
├── requirements.txt
├── tfreadme.py
└── README.md

How It Works

The tool:

1. Reads a Terraform binary plan file
2. Executes terraform show -json
3. Parses the JSON output
4. Classifies resource actions
5. Groups resources by operation
6. Generates a clean Markdown report

Current Capabilities

• Parse Terraform plan files
• Generate Markdown summaries
• Count resources by action
• Count resources by type
• Extract resource names
• Extract resource IDs
• Display Terraform addresses
• Produce review-friendly output

Technologies Used

• Python
• Terraform
• JSON
• tabulate

License

MIT License

Author

Developed by Aswin as a practical DevOps automation tool to simplify Terraform plan reviews and improve infrastructure change visibility.