https://github.com/adamibs/vscode-terraform-live-graph

The Terraform Live Graph Extension for Visual Studio Code is a plugin that allows you to generate a live Terraform graph as you code.
https://github.com/adamibs/vscode-terraform-live-graph

aws azure devops gcp google-cloud-platform terraform vscode vscode-extension

Last synced: 3 days ago
JSON representation

The Terraform Live Graph Extension for Visual Studio Code is a plugin that allows you to generate a live Terraform graph as you code.

• Host: GitHub
• URL: https://github.com/adamibs/vscode-terraform-live-graph
• Owner: adamiBs
• License: mit
• Created: 2023-03-09T21:15:35.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-06-12T10:28:33.000Z (over 1 year ago)
• Last Synced: 2024-11-01T03:33:04.459Z (12 days ago)
• Topics: aws, azure, devops, gcp, google-cloud-platform, terraform, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=adamiBs.terraform-live-graph
• Size: 4.06 MB
• Stars: 236
• Watchers: 3
• Forks: 4
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Terraform Live Graph Extension for VSCode [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Live%20Terraform%20graph%20as%20you%20code!%20&url=https://github.com/adamiBs/vscode-terraform-live-graph&via=adambenshmuel&hashtags=terraform,aws,azure,gcp,vscode,visulization,extension)

[![Price](https://img.shields.io/badge/price-FREE-0098f7.svg)](./LICENSE.md)

[![Downloads](https://img.shields.io/visual-studio-marketplace/d/adamiBs.terraform-live-graph)](https://marketplace.visualstudio.com/items?itemName=adamiBs.terraform-live-graph)

The Terraform Graph Extension for Visual Studio Code is a plugin that allows you to generate a live Terraform graph as you code. This extension makes it easy to visualize your infrastructure and the relationships between resources, helping you to understand how your infrastructure is configured.

![GIF of a demo of the extension](./images/tf-graph-demo.gif)

## Installation

### Prerequisites

1. Install `terraform` from: https://developer.hashicorp.com/terraform/downloads?product_intent=terraform

2. Install `graphviz` from: https://graphviz.org/download/

3. VS Code updated to at least `v1.75.1` of above.

### Extension Installation

1. Open Visual Studio Code.

2. Click on the Extensions icon on the left-hand side of the screen (Ctrl+Shift+X).

3. Search for "Terraform Live Graph" and click "Install".

4. Restart Visual Studio Code.

## Usage

1. Open a Terraform file in Visual Studio Code

2. Activate the extension by selecting "Terraform Graph View" from the Command Palette (`CMD+Shift+p`/`Ctrl+Shift+p` or `F1` opens the Command Palette).

3. A live graph of your Terraform code will appear on the right-hand side of the screen

4. As you write your Terraform code, the graph will update in real-time to reflect your changes

## Requirements

- Terraform must be installed on your system and accessible from the command line ([Download](https://www.terraform.io/downloads.html))

- The Terraform files must be in a valid format

## Issues and Contributions

If you encounter any issues or have any suggestions for improvements, please [open an issue](https://github.com/adamiBs/vscode-terraform-live-graph/issues/new/choose) on the GitHub repository.

If you would like to contribute to the development of this extension, please [follow the instructions here](./CONTRIBUTING.md).

## License

This extension is licensed under the MIT License. See the LICENSE file for more information.