v0.1.0

What and Why

A utility for generating mermaid diagrams from Terraform plans

Usage

1. We will generate a Terraform plan file, specifically tf_plan_prod.json:

terraform plan -out tf_plan_prod

2. After generating the plan file, we will convert it to JSON using Terraform show:

terraform show -json tf_plan_prod > tf_plan_prod.json

3. Once the JSON plan file has been created, run terramaid against it and look for the populated Terramaid.md file!

terramaid -planfile tf_plan_prod.json

cat Terramaid.md

Output:

graph TD;
67(aws_iam_policy) -->|created| 68(aws_iam_policy.policy)
69(aws_s3_bucket) -->|created| 70(aws_s3_bucket.this)