Repository navigation
Releases
Releases · danushkastanley/tfviz
v0.1.0-alpha.2
v0.1.0-alpha.1
First alpha of tfviz. It turns Terraform and OpenTofu plans and state into a single, self-contained HTML diagram that you can open offline or download from CI.
Alpha. Commands, flags and the report format may change before 0.1.0. It has been tested on synthetic stacks, not yet on your infrastructure. Please try it on a real stack and tell us what's wrong.
What's included
- Plan reviews.
tfviz planshows what will be added, changed, replaced or destroyed, placed in your AWS account, region, VPC and subnet layout. - State reports.
tfviz statereads exported state JSON, a version-4.tfstatefile, or an object in S3 read with your normal AWS credentials. - Private local explorer.
tfviz exploreserves the same interface from your machine only. You can refresh it after you apply. - Safe sharing.
--safe-sharereplaces names, IDs, ARNs, accounts and network addresses with consistent stand-ins. - Official AWS icons.
--iconsuses the AWS icon pack you download. tfviz doesn't ship the icons itself. - Coverage. 42 AWS resource types. Others appear with limited detail.
- Private by design.
- Secrets, tags, user data and policies never reach the report.
- Reports make no network requests.
- tfviz has no telemetry.
Install
macOS and Linux, on arm64 and amd64. Verify before you run it:
VERSION=0.1.0-alpha.1 OS=darwin ARCH=arm64 # or linux / amd64
base=https://github.com/danushkastanley/tfviz/releases/download/v${VERSION}
curl -fsSLO "${base}/tfviz_${VERSION}_${OS}_${ARCH}.tar.gz"
curl -fsSLO "${base}/tfviz_${VERSION}_checksums.txt"
grep " tfviz_${VERSION}_${OS}_${ARCH}.tar.gz$" "tfviz_${VERSION}_checksums.txt" | shasum -a 256 -c -
gh attestation verify "tfviz_${VERSION}_${OS}_${ARCH}.tar.gz" --repo danushkastanley/tfviz
tar -xzf "tfviz_${VERSION}_${OS}_${ARCH}.tar.gz" tfvizEach archive has an SBOM, and the build provenance is attested by GitHub.
Quick start
terraform plan -out=tfplan
terraform show -json tfplan | tfviz plan --input - --output plan-review.htmlKnown limits
- AWS only. Azure and Google Cloud are planned.
- Untested outside our own tests. It hasn't yet been run against a real S3 bucket with SSO, in a Jenkins pipeline, or in the branded Chrome, Firefox and Safari browsers.
- Platforms. There are no Windows builds yet.
- Not a security review. Relationships are recorded associations, not observed traffic, and a plan is a proposal, not the result.
Documentation is in docs/. Please report problems as issues. Never attach a plan, state or unredacted report; use --safe-share if you need to share one.