A command-line utility that summarizes Terraform plan output into concise tables, trees, or JSON for quick review.
tf-summarize is a command-line utility that parses Terraform plan output and generates a concise summary of resource changes. It helps infrastructure engineers quickly see what resources will be added, changed, or destroyed without reading through lengthy plan logs. The tool supports multiple output formats like tables, trees, JSON, and Markdown for flexible integration into workflows.
Infrastructure engineers, DevOps practitioners, and platform teams who regularly use Terraform for infrastructure provisioning and need to review plan outputs efficiently.
Developers choose tf-summarize because it dramatically reduces the time spent parsing verbose Terraform plans, provides multiple readable output formats, and integrates seamlessly into CI/CD pipelines. Its ability to work directly with plan files and support for Docker/GitHub Actions makes it a lightweight, versatile addition to any Terraform workflow.
A command-line utility to print the summary of the terraform plan
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Supports tables, trees, JSON, HTML, and Markdown outputs, as shown in usage examples like `tf-summarize -tree tfplan` for hierarchical views.
Accepts Terraform plan files directly or JSON from `terraform show -json`, eliminating manual parsing, evidenced by commands like `tf-summarize tfplan`.
Installable via Go, Homebrew, asdf, Docker, and GitHub Actions, making it adaptable to various environments, as detailed in the install section.
Easily embeddable in GitHub Actions and Codefresh pipelines to comment plan summaries in PRs, with example workflows provided in the README.
Allows piping JSON output to tools like `fx` for interactive exploration, enhancing the review process with commands like `tf-summarize -json tfplan | fx`.
Cannot run Terraform plans directly; requires pre-generated plan or JSON files, as noted in the TODO list with 'Directly run the terraform plan and show the summary' still pending.
The Docker image lacks Terraform binary, so it only works with JSON files, not raw plan files, requiring an extra conversion step, as mentioned in the Docker install notes.
For optimal GitHub Actions integration, it relies on the external `kishaningithub/setup-tf-summarize` action, which adds a dependency that might not be maintained.