Skip to content

A utility for generating Mermaid diagrams from Terraform configurations

License

Notifications You must be signed in to change notification settings

xip-niekneuij/Terramaid

 
 

Repository files navigation

Terramaid

A utility for creating Mermaid diagrams from Terraform configurations

Introduction

Terramaid transforms your Terraform resources and plans into visually appealing Mermaid diagrams. By converting complex infrastructure into easy-to-understand diagrams, Terramaid enhances documentation, simplifies review processes, and fosters better collaboration among team members. Whether you're looking to enrich your project's documentation, streamline reviews, or just bring a new level of clarity to your Terraform configurations, Terramaid is the perfect utility to integrate into your development workflow.

Demo

Installation

If you have a functional go environment, you can install with:

go install github.com/rosesecurity/terramaid/v1@latest

Build from source:

git clone [email protected]:RoseSecurity/terramaid.git
cd terramaid
make build

Docker Image

Run the following command to utilize the Terramaid Docker image:

docker run -it -v $(pwd):/usr/src/terramaid rosesecurity/terramaid:latest

CI/CD Integrations

Terramaid is designed to easily integrate with existing pipelines and workflows. For more information on sample GitHub Actions and GitLab CI/CD Pipelines, feel free to check out CI/CD Integrations

About

A utility for generating Mermaid diagrams from Terraform configurations

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 71.6%
  • HCL 18.1%
  • Dockerfile 7.3%
  • Makefile 2.9%
  • Ruby 0.1%