{"id":13564713,"url":"https://github.com/inkdrop-org/inkdrop-visualizer","last_synced_at":"2025-04-05T02:12:20.825Z","repository":{"id":214213423,"uuid":"733018250","full_name":"inkdrop-org/inkdrop-visualizer","owner":"inkdrop-org","description":"Visualizes your Terraform","archived":false,"fork":false,"pushed_at":"2024-06-03T14:13:46.000Z","size":7196,"stargazers_count":482,"open_issues_count":15,"forks_count":23,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-29T01:14:57.426Z","etag":null,"topics":["atlantis","aws","cloud","devops","terraform","visualization"],"latest_commit_sha":null,"homepage":"https://inkdrop.ai/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/inkdrop-org.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-18T11:31:02.000Z","updated_at":"2025-03-26T03:47:52.000Z","dependencies_parsed_at":"2024-03-12T14:52:18.565Z","dependency_job_id":"f412b749-1a6a-47e9-a90a-ce7063c07e13","html_url":"https://github.com/inkdrop-org/inkdrop-visualizer","commit_stats":null,"previous_names":["inkdrop-org/terraform-visualizer-cli","inkdrop-org/inkdrop-visualizer"],"tags_count":66,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkdrop-org%2Finkdrop-visualizer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkdrop-org%2Finkdrop-visualizer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkdrop-org%2Finkdrop-visualizer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkdrop-org%2Finkdrop-visualizer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/inkdrop-org","download_url":"https://codeload.github.com/inkdrop-org/inkdrop-visualizer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247276189,"owners_count":20912288,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["atlantis","aws","cloud","devops","terraform","visualization"],"created_at":"2024-08-01T13:01:34.872Z","updated_at":"2025-04-05T02:12:20.797Z","avatar_url":"https://github.com/inkdrop-org.png","language":"TypeScript","readme":"\u003cp align=\"center\"\u003e\n  \u003cpicture width=\"100px\" align=\"center\"\u003e\n      \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://github.com/inkdrop-org/inkdrop-visualizer/assets/86591160/f93f558f-81e8-4d70-9dcd-d7512b3a47d4\"\u003e\n      \u003cimg alt=\"Inkdrop\" src=\"https://github.com/inkdrop-org/inkdrop-visualizer/assets/86591160/cfe32c6e-3634-4d68-9749-d2c2d0468ecc\" width=\"100px\" align=\"center\"\u003e\n    \u003c/picture\u003e\n  \u003ch1 align=\"center\"\u003eTerraform Visualizer\u003c/h1\u003e\n  \u003cp align=\"center\"\u003e\n    Inkdrop is a CLI tool that creates interactive diagrams to visualize your Terraform. \n    \u003cbr/\u003e\n    It helps you onboard engineers, generate documentation and understand dependencies faster. \n  \u003c/p\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/inkdrop-org/inkdrop-visualizer/releases\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/inkdrop-org/inkdrop-visualizer?color=%239F50DA\u0026display_name=tag\u0026label=Version\" alt=\"Latest Release\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/inkdrop-org/inkdrop-visualizer/graphs/commit-activity\"\u003e\u003cimg src=\"https://img.shields.io/github/commit-activity/m/inkdrop-org/inkdrop-visualizer\" alt=\"Commit Activity\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/inkdrop-org/inkdrop-visualizer/stargazers\" rel=\"nofollow\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/inkdrop-org/inkdrop-visualizer\" alt=\"Stars\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cpicture align=\"center\"\u003e\n    \u003ca href=\"https://demo.inkdrop.ai/\"\u003e\u003cimg src=\"https://github.com/inkdrop-org/inkdrop-visualizer/assets/86591160/5de99a85-2636-40c8-b82d-7f64c7dc7178\" alt=\"demo\"\u003e\u003c/a\u003e \n  \u003c/picture\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/inkdrop-org/inkdrop-gh-action-example/pull/5\"\u003e🚀 CI Integration\u003c/a\u003e | \u003ca href=\"https://demo.inkdrop.ai\"\u003e💻 Interactive Demo\u003c/a\u003e | \u003ca href=\"https://github.com/inkdrop-org/inkdrop-visualizer/issues/new\"\u003e Give Feedback\u003c/a\u003e | \u003ca href=\"https://join.slack.com/t/inkdrop-group/shared_invite/zt-2jjbx5wz4-lyN4YLzlwuccD00rnMTDew\"\u003e🙌 Join the Slack\u003c/a\u003e\n\u003c/p\u003e \n\u003c/p\u003e\n\n## Overview\nInkdrop generates a visual, interactive map of your resources helps you understand relationships and dependencies.\n\nInkdrop takes your Terraform Plan and renders it locally as an interactive WebUI, allowing you to get a clean overview in seconds.\n\nBenefits:\n- Review proposed changes at a glance.\n- Document your infrastructure automatically.\n- Onboard engineers to a new project 10 times faster.\n\n## Installation\n**With Brew:**\n\n```\nbrew tap inkdrop-org/inkdrop-visualizer\nbrew install inkdrop-visualizer\n```\n**With Linux:**\n\n```\nwget https://github.com/inkdrop-org/inkdrop-visualizer/releases/latest/download/inkdrop-linux-x64.tar.gz\ntar -xzf inkdrop-linux-x64.tar.gz\nchmod +x inkdrop\nmv inkdrop /usr/local/bin/\n```\n\n**With NPM:**\n\n```\nnpm install -g inkdrop-visualizer\n```\n\n[**With Docker:**](#Docker-Usage)\n\n## Usage\n### CLI Usage\nRun inkdrop where you would run Terraform init/plan.\n```\nterraform plan -out plan.out\ninkdrop plan.out\n```\nThis will launch an interactive WebUI showing you which resources will change according to your tf.plan.\n\nWhen you click on a resource you will get additional details such as variables and outputs used. \n\nAt the top left of the UI you can filter the diagram by resource type, tags and other built-in debugging filters .\n\n### Command Line Arguments\n\n| Argument           | Description                                                           | Example Usage                              |\n|--------------------|-----------------------------------------------------------------------|--------------------------------------------|\n| (no argument)      | Automatically launches a browser tab to display the diagram interactively.| `inkdrop`                              |\n| `plan-filename`   | Visualizes the impact of changes defined in a specified terraform plan (or plan JSON) file. | `inkdrop plan.out`                  |\n| `--state-dirs`     | List of directories that contain Terraform configuration files with configured backends. This option allows visualizing multiple states in a single diagram.        | `inkdrop plan.out --state-dirs ./path/to/tf/dir1 ./path/to/tf/dir2`                           |\n| `--help`, `-h`     | Displays help information about the CLI tool and its commands.        | `inkdrop --help`                           |\n| `--version`, `-v`  | Shows the current version number of the CLI tool.                     | `inkdrop --version`                        |\n| `--debug`          | Shows the logs of the diagram generation.                             | `inkdrop --debug`                          |\n| `--path`           | Sets the working directory to a specified Terraform project path.     | `inkdrop --path ./repos/my-tf-project`     |\n| `--renderer-port`  | Defines the port for the local diagram rendering service (default: `3000`). | `inkdrop --renderer-port 8080`       |\n\n\n\u003e **Note:** Without a plan file the diagram will be missing some functionality\n\n### CI Usage\n\nTo run inkdrop from your CI process you will need to follow the following short tutorials: \n\n**[Github example](/github-action-integration)**\n\n**[Atlantis example](/atlantis-integration)**\n\n**[Gitlab example (coming soon)]**\n\nThe runner will comment an SVG Image in the PR. Using the Inkdrop extension this image becomes interactive and behaves like the CLI version when you click on it.\n\n### Docker Usage\n\n```sh\ndocker run \\\n  -v /path/to/your/terraform/root:/tfroot \\  # Mount your Terraform root directory\n  --env TF_VERSION=1.5.7 \\                   # Set the Terraform version you're using\n  -p 3000:3000 \\                             # Map port 3000 for the WebUI\n  -it \\                                      # Use -d instead of -it to run the container in detached mode\n  inkdroporg/inkdrop:latest \\\n  plan.out [additional arguments]\n```\n\nReplace `/path/to/your/terraform/root` with the absolute path to your local Terraform root directory. Adjust the `TF_VERSION` to match the version of Terraform you're using locally (e.g., `1.5.7`). The `plan.out` argument refers to your Terraform plan file, and you can add any additional arguments required.\n\n## Misc\n### Troubleshooting\n\nIf you encounter any issues while using inkdrop, please use the `--debug` flag and report the issue. We're looking forward to help.\n\n### Telemetry\n\nAs this is a local CLI tool we have no information about your setup. The only telemetry we collect is a simple ping to our server, to estimate usage of the tool and the command line arguments you are using. To turn it off simply use the flag `--telemetry-off`.\n\n### Development\nWe welcome contributions and feedback! Feel free to open GitHub issues for bugs or feature requests.\n\n### Contact\n\nFeel free to reach out:\n\n[Slack](https://join.slack.com/t/inkdrop-group/shared_invite/zt-2jjbx5wz4-lyN4YLzlwuccD00rnMTDew)\n\n[Email](mailto:antoine@inkdrop.ai)\n\n[Calendar](https://calendly.com/antoine-inkdrop/25-min)\n\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finkdrop-org%2Finkdrop-visualizer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finkdrop-org%2Finkdrop-visualizer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finkdrop-org%2Finkdrop-visualizer/lists"}