Features - tfplan2md

What Sets Us Apart

The features that make the biggest difference in your Terraform reviews

Inline Diffs

Character-level highlighting shows exactly what changed within a value. Added text in green, removed text in red—spot changes instantly.

→ View examples

Firewall Rule Interpretation

Renders complex Azure Firewall rule collections as readable tables with protocols, ports, and actions clearly displayed.

→ View examples

NSG Rule Interpretation

Renders Network Security Group rules as readable tables, making security changes easy to audit at a glance.

→ View examples

Role Assignment Mapping

Resolves cryptic GUIDs to human-readable names: Principal IDs become "Jane Doe", Role Definition IDs become "Reader", and Scope IDs become "rg-myresourcegroup".

→ View examples

Large Value Formatting

Handles large text blocks (like JSON policies or scripts) by showing computed diffs with inline highlighting instead of raw text walls.

→ View examples

PR Rendering Optimization

Designed and tested for rendering in pull request comments on Azure DevOps Services and GitHub. Reports look great where they matter most.

→ View examples

Friendly Resource Names

Displays friendly names for resources instead of complex resource ID strings. See "kv-tfplan2md" instead of a 200-character Azure resource ID.

→ Learn more

Azure DevOps Variable Groups

Shows all variables (regular and secret) in variable group changes with full metadata. Secret values displayed as "(sensitive / hidden)" while preserving names and attributes.

→ View examples

Built-In Capabilities

Solid capabilities that improve readability and usability

Plan Summary

High-level overview table showing counts of adds, changes, replaces, and destroys by resource type.

→ Learn more

Module Grouping

Groups resources logically by their Terraform module hierarchy (e.g., module.network.module.monitoring).

→ Learn more

Collapsible Details

Hides verbose resource details inside expandable sections to keep PR comments readable and scannable.

→ Learn more

Tag Visualization

Renders resource tags with specific icons and formatting for easy scanning of metadata.

→ Learn more

Smart Iconography

Adds context-aware icons for common attributes like Locations (🌍), IPs (🌐), Ports (🔌), and booleans.

→ Learn more

Custom Templates

Allows users to completely customize the markdown output using Scriban templates.

→ Learn more

CI/CD Integration

Native support and examples for GitHub Actions, Azure DevOps, and GitLab CI. Just pipe terraform output to the Docker container.

→ View integration guides

Provider Agnostic Core

Works with any Terraform provider (AWS, GCP, etc.) using standard resource rendering. Azure gets specialized renderers.

→ View providers

Local Resource Names

In modules, displays just the local resource name (e.g., "hub") instead of the full module path for cleaner summaries.

→ Learn more

Also Included

Security and quality-of-life improvements

Sensitive Value Masking

Automatically masks values marked as sensitive in Terraform to prevent accidental exposure.

Container Support

AOT-compiled native binary in 14.7MB FROM scratch container. Sub-second startup, minimal attack surface.

Debug Output

Single --debug flag appends diagnostic info showing principal mapping status, template resolution, and failed ID lookups.

Dark/Light Mode

Website supports dark and light theme toggle for comfortable viewing in any environment.