Graph Command

Generate a diagram directly from your terminal. pluralith graph creates a Terraform execution plan, draws a diagram and pushes it to the Pluralith dasboard. Headless export of diagrams as a PDF is also supported.

pluralith graph [flags]

Example

Here's a quick example on how to generate a diagram in any given terraform directory. Copy it to your terminal, hit enter and see the magic happen! The Pluralith dashboard should open and show the diagram.

pluralith graph --title "Mark I" --author "Tony Stark" --version "0.0.1" --show-changes

Available Flags

Flag	Description	Type
--local-only	The diagram will not be pushed to the Pluralith Dashboard. Instead, a PDF export of the Diagram gets generated locally and saved to disk	bool
--show-changes	Determines whether the exported diagram highlights changes made in the latest Terraform plan	bool
--show-drift	Determines whether the exported diagram highlights resource drift detected by Terraform	bool
--show-costs	Determines whether the exported diagram includes cost information (requires Infracost)	bool
--cost-mode	Determines which costs are shown. Can be delta or total (default delta)	string
--cost-period	Determines over which period costs are aggregated. Can be hour or month (default month)	string
--cost-usage-file	Path to an infracost usage file to be used for the cost breakdown	string
--file-name	The name of the exported PDF	string
--out-dir	The directory the diagram should be exported to	string
--title	The title of your diagram, will be displayed in the PDF output	string
--version	The architecture version, will be displayed in the PDF output	string
--author	The author of the diagram, will be displayed in the PDF output	string
--var	A variable to pass to Terraform. Can be specified multiple times. (Format: --var='NAME=VALUE')	string
--var-file	Path to a variable file to pass to Terraform. Can be specified multiple times.	string
--plan-file	Path to an existing execution plan. (Generated with terraform plan -out plan.bin)	string
--plan-file-json	Path to an existing JSON plan state. (Generated with terraform plan -out plan.bin and terraform show -json plan.bin > plan.json)	string
--config-file	Path to a custom pluralith config file	string