germainlefebvre4/tf2report repository overview

⁠Quick reference

• Maintained by:
  Germain LEFEBVRE⁠

• Where to get help:
  Github Discussions⁠

⁠Supported tags and respective Dockerfile links

• latest, v0, v0.1, v0.1.0⁠

⁠Quick reference (cont.)

• Where to file issues:
  https://github.com/germainlefebvre4/tf2report/issues⁠⁠

• Supported architectures: (more info⁠⁠)
  amd64, arm64

• Source of this description:
  tf2report repo's docs/dockerhub/ directory⁠ (history⁠)

⁠What is TF2Report?

TF2Report is a CLI tool that analyzes Terraform plan files and generates human-readable resource change reports.

⁠Features

• Parse Terraform plan files: Analyze Terraform plan JSON files to extract resource changes
• Multiple output formats: Generate reports in Markdown, plain text, or JSON format
• Flexible filtering: Filter by resource type and change action (create, update, delete, replace)
• Configuration file support: Use a tf2report.yaml file to specify default settings for your projects
• CI/CD integration: Lightweight CLI tool that can be easily integrated into your automation workflows
• Detailed summaries: Get clear overviews of infrastructure changes before applying them

⁠How to use this image

TF2Report helper.

tf2report analyzes Terraform plan files and generates resource change reports.

It parses Terraform plan JSON files, extracts resource changes, and generates
summaries in multiple output formats including Markdown, plain text, and JSON.

Usage:
  tf2report [flags]

Flags:
  -a, --action strings   filter by action (create, update, delete, replace)
      --config string    config file path (default: ./tf2report.yaml)
  -f, --format string    output format (markdown, text, json)
  -h, --help             help for tf2report
  -p, --plan string      path to Terraform plan JSON file
  -t, --type strings     filter by resource type (can be specified multiple times)
  -v, --verbose          verbose output
      --version          version for tf2report

⁠License

View license information⁠⁠ for the software contained in this image.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.