docs/src/data/flags/list-format.mdx
import { Aside } from '@astrojs/starlight/components';
Controls how the list results are displayed:
text (default): Simple space-separated list of configurations. Best for quick overview and scripting.long: Detailed view showing type (unit/stack), path, and module information. Useful for auditing and documentation.tree: Hierarchical view showing directory structure. Perfect for understanding infrastructure organization.dot: Output in DOT format for visualization. Generates a graph using the GraphViz DOT language. Ideal for creating visual dependency graphs.These values all have shortcuts as standalone flags:
--long / -l for long--tree / -T for treeExamples:
# Default text format - Great for quick overview
$ terragrunt list
live/dev/db live/dev/ec2 live/dev/vpc
live/prod/db live/prod/ec2 live/prod/vpc
# Long format - Useful for reading structured information quickly
$ terragrunt list -l
Type Path Dependencies
unit live/dev/db live/dev/vpc
unit live/dev/ec2 live/dev/db, live/dev/vpc
unit live/dev/vpc
unit live/prod/db live/prod/vpc
unit live/prod/ec2 live/prod/db, live/prod/vpc
unit live/prod/vpc
# Tree format - Optimal for visualizing structure
$ terragrunt list -T
.
╰── live
├── dev
│ ├── db
│ ├── ec2
│ ╰── vpc
╰── prod
├── db
├── ec2
╰── vpc
# DOT format - Useful for visualizing dependency graphs
$ terragrunt list --format=dot --dependencies
digraph {
"live/dev/vpc" ;
"live/dev/db" ;
"live/dev/ec2" ;
"live/dev/db" -> "live/dev/vpc";
"live/dev/ec2" -> "live/dev/db";
"live/dev/ec2" -> "live/dev/vpc";
"live/prod/vpc" ;
"live/prod/db" ;
"live/prod/ec2" ;
"live/prod/db" -> "live/prod/vpc";
"live/prod/ec2" -> "live/prod/db";
"live/prod/ec2" -> "live/prod/vpc";
}
# Render the DOT output to an image using GraphViz
$ terragrunt list --format=dot | dot -Tpng > graph.png
The examples above demonstrate a typical multi-environment infrastructure setup with networking, compute, and data layers. Each format provides a different perspective on the same infrastructure, making it easier to understand and manage your Terragrunt configurations.
<Aside type="tip" title="DOT Format Alias">The dag graph command is an alias for list --format=dot. Both commands produce identical DOT format output:
terragrunt dag graph
# Equivalent to:
terragrunt list --format=dot --dependencies --external