tfsumpy: Effortless Terraform Plan Summaries

Welcome to tfsumpy — the modern, Python-based CLI tool for summarizing and reviewing Terraform plan files. Instantly understand what will change in your infrastructure, catch surprises, and share clear, readable summaries with your team.

🚀 Why tfsumpy?

Instant Plan Summaries: See what will be created, updated, or destroyed at a glance.
Multiple Output Formats: Console, Markdown, and JSON output for any use case.
Template-Based Output: Consistent, customizable output formats.
Sensitive Data Protection: Automatically redact secrets and sensitive values.
Customizable: Configure redaction and output to fit your workflow.
No Cloud Required: Runs locally, works with any Terraform JSON plan.

🔥 Quick Start

1. Install

pip install tfsumpy

2. Generate a Terraform plan JSON

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

3. Summarize your plan

tfsumpy plan.json

💡 Usage Scenarios

Basic Summary

tfsumpy plan.json

Shows a concise summary of all resource changes.

Detailed Attribute Changes

tfsumpy plan.json --hide-changes=false

See exactly which attributes will change for each resource.

Full Resource Details

tfsumpy plan.json --detailed

Get a deep dive into every resource and its planned state.

Output Formats

Console Output (Default)

tfsumpy plan.json

Color-coded, human-readable output in your terminal.

Markdown Output

tfsumpy plan.json --output markdown > plan_summary.md

Generates a beautiful Markdown summary, perfect for code reviews or documentation.

JSON Output

tfsumpy plan.json --output json > plan_summary.json

Structured JSON output for integration with other tools or automation.

Custom Redaction & Config

tfsumpy plan.json --config myconfig.json

Redact custom patterns or tweak output using a JSON config file.

Debugging

tfsumpy plan.json --debug

Enables verbose logging for troubleshooting.

⚙️ Configuration Example

Create a config.json to redact custom sensitive patterns:

{
  "sensitive_patterns": [
    { "pattern": "password|secret|key", "replacement": "[REDACTED]" }
  ]
}

📚 Documentation & API

Plan Analysis: How tfsumpy analyzes your plans
Configuration: Customizing output and redaction
Advanced Usage: Output formats and more
Analyzers API: Extend or integrate tfsumpy
Reporters API: Custom output formats
Models API: Data structures

🤝 Contributing

We welcome contributions! See our Contributing Guide to get started.

📝 License

tfsumpy is released under the MIT License. See the LICENSE file for details.

🚦 Project Status

Status: Beta — Feedback and contributions are welcome!