CLI options

Commands

The main commands available in Terragrunt are:

• Main commands
  • OpenTofu shortcuts
  • run
  • exec

The commands relevant to managing a Terragrunt stack are:

• Stack commands
  • stack generate
  • stack run
  • stack output

The commands relevant to managing OpenTofu/Terraform state backends are:

• Backend commands
  • backend bootstrap
  • backend delete
  • backend migrate

The commands for interacting with Terragrunt files, written in HashiCorp Configuration Language (HCL):

• HCL commands
  • hcl validate
  • hcl format

The commands relevant to managing an IaC catalog are:

• Catalog commands
  • catalog
  • scaffold

The commands relevant to discovering Terragrunt configurations are:

• Discovery commands
  • find
  • list

The commands used for managing Terragrunt configuration itself are:

• Configuration commands
  • render
  • info
  • dag

Main commands

OpenTofu shortcuts

Terragrunt is an orchestration tool for OpenTofu/Terraform, so with a couple exceptions, you can generally use it as a drop-in replacement for OpenTofu/Terraform. Terragrunt has a shortcut for most OpenTofu commands, you can usually just replace tofu or terraform with terragrunt and it will do what you expect.

For example:

# This will run `tofu/terraform apply` for you.
terragrunt apply

The list of shortcuts Terragrunt supports are:

• apply
• destroy
• force-unlock
• import
• init
• output
• plan
• refresh
• show
• state
• test
• validate

If you want to run a command that doesn’t have a shortcut in Terragrunt, you can use the run command.

run

Run the provided OpenTofu/Terraform command against the unit in the current working directory.

Example:

terragrunt run plan

Note that the run command is a more explicit way to run OpenTofu/Terraform commands, and it provides some flexible options that are not available with the shortcut commands.

The run command also supports the following flags that can be used to drive runs in multiple units:

• --all: Run the provided OpenTofu/Terraform command against all units in the current stack. This is equivalent to the deprecated run-all command.
• --graph: Run the provided OpenTofu/Terraform command against the graph of dependencies for the unit in the current working directory. This is equivalent to the deprecated graph command.

You may, at times, need to explicitly separate the flags used for Terragrunt from those used for OpenTofu/Terraform. In those circumstances, you can use the argument -- to separate the Terragrunt flags from the OpenTofu/Terraform flags.

Example:

terragrunt run -- plan -no-color

exec

Execute an arbitrary command orchestrated by Terragrunt.

In contrast to the run command, which will always invoke OpenTofu/Terraform, the exec command allows for execution of any arbitrary command via Terragrunt.

This can be useful, as it allows you full control over the process that is being orchestrated by Terragrunt, while taking advantage of Terragrunt’s features such as dependency resolution, inputs, and more.

Example:

terragrunt exec -- echo "Hello, Terragrunt!"

When using exec, you will have almost the exact same context that you have when using run, including inputs.

Example:

inputs = {
  message = "Hello, Terragrunt!"
}

$ terragrunt exec -- env | grep 'TF_VAR_message'
TF_VAR_message=Hello, Terragrunt!

Stack commands

The terragrunt stack commands provide an interface for managing collections of Terragrunt units defined in terragrunt.stack.hcl files. These commands simplify the process of handling multiple infrastructure units by grouping them into a “stack”, reducing code duplication and streamlining operations across environments.

stack generate

The stack generate command is used to generate a stack of terragrunt.hcl files based on the configuration provided in the terragrunt.stack.hcl file.

Given the following terragrunt.stack.hcl configuration:

locals {
  version = "v0.68.4"
}

unit "app1" {
  source = "github.com/gruntwork-io/terragrunt.git//test/fixtures/inputs?ref=${local.version}"
  path   = "app1"
}

unit "app2" {
  source = "github.com/gruntwork-io/terragrunt.git//test/fixtures/inputs?ref=${local.version}"
  path   = "app2"
}

Executing generate:

terragrunt stack generate

Will create the following directory structure:

.terragrunt-stack/
├── app1/
│   └── terragrunt.hcl
└── app2/
    └── terragrunt.hcl

Notes:

• Parallel Execution: Stack generation runs concurrently to improve performance. The number of parallel tasks is determined by the GOMAXPROCS environment variable and can be explicitly controlled using the --parallelism flag:

terragrunt stack generate --parallelism 4

• Automatic Discovery: The command automatically discovers all terragrunt.stack.hcl files within the directory structure and generates them in parallel.

• Path Restrictions: If an absolute path is provided as an argument, the command will throw an error. Only relative paths within the working directory are supported.

• Validation of Units and Stacks: During the stack generation, the system will validate that each unit and stack’s target directory contains the appropriate configuration file (terragrunt.hcl for units and terragrunt.stack.hcl for stacks). This ensures the directories are correctly structured before proceeding with the stack generation. To skip this validation, you can use the --no-stack-validate flag:

terragrunt stack generate --no-stack-validate

stack run

The stack run * command allows users to execute IaC commands across all units defined in a terragrunt.stack.hcl file. This feature facilitates efficient orchestration of operations on multiple units, simplifying workflows for managing complex infrastructure stacks.

Examples:

Run a plan on each unit:

terragrunt stack run plan

Apply changes for each unit:

terragrunt stack run apply

Destroy all units:

terragrunt stack run destroy

Flags:

• --no-stack-generate : Disable automatic stack regeneration before running the command. By default, stack run will regenerate the stack based on the terragrunt.stack.hcl configuration before executing the requested operation. Using this flag prevents automatic regeneration and executes the command using the existing .terragrunt-stack directory.

stack output

The terragrunt stack output command allows users to retrieve and interact with outputs from multiple units within a Terragrunt stack. This feature simplifies handling infrastructure outputs by consolidating them into a single view.

Basic Usage:

Executing terragrunt stack output in a stack directory produces an aggregated output from all units within the stack:

$ terragrunt stack output
service.output1 = "output1"
service.output2 = "output2"
db.output1 = "output1"
db.output2 = "output2"

To retrieve outputs for a specific unit, specify the unit name:

$ terragrunt stack output project1_app1
project1_app1 = {
  complex = {
    delta     = 0.02
    id        = 2
    name      = "name1"
    timestamp = "2025-02-07T21:05:51Z"
  }
  complex_list = [{
    delta     = 0.02
    id        = 10
    name      = "name1"
    timestamp = "2025-02-07T21:05:51Z"
    }, {
    delta     = 0.03
    id        = 20
    name      = "name10"
    timestamp = "2025-02-07T21:05:51Z"
  }]
  custom_value1 = "value1"
  data          = "app1"
  list          = ["1", "2", "3"]
}

You can also retrieve a specific output from a unit:

$ terragrunt stack output project1_app1.custom_value1
project1_app1.custom_value1 = "value1"

Flags:

• --no-stack-generate : Disable automatic stack regeneration before retrieving outputs. By default, stack output will regenerate the stack before fetching outputs. Using this flag prevents automatic regeneration and retrieves outputs using the existing .terragrunt-stack directory.

• --format=<format> : Specify the output format. Terragrunt provides multiple output formats for easier parsing and integration with other tools:

To retrieve outputs in structured JSON format:

$ terragrunt stack output --format json project1_app2
{
  "project1_app2": {
    "complex": {
      "delta": 0.02,
      "id": 2,
      "name": "name2",
      "timestamp": "2025-02-07T21:05:51Z"
    },
    "complex_list": [
      {
        "delta": 0.02,
        "id": 2,
        "name": "name2",
        "timestamp": "2025-02-07T21:05:51Z"
      },
      {
        "delta": 0.03,
        "id": 2,
        "name": "name3",
        "timestamp": "2025-02-07T21:05:51Z"
      }
    ],
    "custom_value2": "value2",
    "data": "app2",
    "list": [
      "a",
      "b",
      "c"
    ]
  }
}

Accessing a specific list inside JSON format:

$ terragrunt stack output --format json project1_app2.complex_list
{
  "project1_app2.complex_list": [
    {
      "delta": 0.02,
      "id": 2,
      "name": "name2",
      "timestamp": "2025-02-07T21:05:51Z"
    },
    {
      "delta": 0.03,
      "id": 2,
      "name": "name3",
      "timestamp": "2025-02-07T21:05:51Z"
    }
  ]
}

The raw format returns outputs as plain values without additional structure. When accessing lists or structured outputs, indexes are required to extract values.

Retrieving a simple value:

$ terragrunt stack output --format raw project1_app2.data
app2

stack clean

Running terragrunt stack clean removes the .terragrunt-stack directory, which is generated by the terragrunt stack generate or terragrunt stack run commands. This can be useful when you need to remove generated configurations or troubleshoot issues.

Backend commands

backend bootstrap

Bootstrap the OpenTofu/Terraform state backend.

terragrunt backend bootstrap

Using this command bootstraps the resources described in your remote_state block in your Terragrunt configuration.

If any of the resources described in the remote_state block need provisioning, bootstrap will provision them.

For example, given the following remote_state block:

# terragrunt.hcl
remote_state {
  backend = "s3"
  config = {
    bucket  = "mybucket"
    key     = "path/to/my/key"
    region  = "us-east-1"
    encrypt = true

    dynamodb_table = "tf-lock"

    accesslogging_bucket_name = "mybucket-logs"
  }
}

Running terragrunt backend bootstrap will ensure the availability of:

• An S3 bucket named mybucket in the us-east-1 region with the following enabled:
  • Server Side Encryption (SSE)
  • Versioning
  • TLS Enforcement
• A DynamoDB table named tf-lock in the us-east-1 region with SSE.
• An S3 bucket named mybucket-logs configured as the access log destination for the mybucket bucket.

The bootstrap command is idempotent. If the resources already exist, bootstrap will not provision them again.

Flags:

• --all: Bootstrap all units discovered in the current working directory.
• --config: Path to the Terragrunt configuration file to use to bootstrap the resources.
• --download-dir: Path to download OpenTofu/Terraform modules into. The default is .terragrunt-cache.

Note:

The flag --backend-bootstrap is equivalent to explicitly running the bootstrap command. Using it in conjunction with any run command will result in any required bootstrapping to be performed prior to initiating the run.

backend delete

Delete the OpenTofu/Terraform state backend.

terragrunt backend delete

Using this command deletes the backend state file for the current Terragrunt unit.

For example, given the following remote_state block:

# terragrunt.hcl
remote_state {
  backend = "s3"
  config = {
    bucket  = "mybucket"
    key     = "path/to/my/key"
    region  = "us-east-1"
    encrypt = true

    dynamodb_table = "tf-lock"

    accesslogging_bucket_name = "mybucket-logs"
  }
}

Running terragrunt backend delete will delete the backend state file located at path/to/my/key in the mybucket bucket.

Flags:

• --all: Delete backend state files for all units discovered in the current working directory.
• --config: Path to the Terragrunt configuration file to use to delete the resources.
• --download-dir: Path to download OpenTofu/Terraform modules into. The default is .terragrunt-cache.
• --force: Force the deletion of the backend state file. By default, Terragrunt will refuse to delete backend state files if the bucket does not have versioning enabled.

backend migrate

Migrate the OpenTofu/Terraform state backend.

terragrunt backend migrate old-unit new-unit

This command will migrate the OpenTofu/Terraform state backend from the old unit to the new unit.

You will typically want to use this command if you are using a key attribute for your remote_state block that uses the path_relative_to_include function, and you want to rename the unit.

For example, given the following filesystem structure:

.
├── old-unit-name
│   └── terragrunt.hcl
└── root.hcl

# root.hcl

remote_state {
  backend = "s3"
  generate = {
    path      = "backend.tf"
    if_exists = "overwrite"
  }
  config = {
    bucket         = "my-tofu-state"
    key            = "${path_relative_to_include()}/tofu.tfstate"
    region         = "us-east-1"
    encrypt        = true
    dynamodb_table = "my-lock-table"
  }
}

# old-unit-name/terragrunt.hcl

include "root" {
  path = find_in_parent_folders("root.hcl")
}

You couldn’t simply rename the old-unit-name directory to new-unit-name and run terragrunt apply in new-unit-name, because the change in the evaluated value for path_relative_to_include() would result in a new state key for the new-unit-name unit.

Instead, you can use the backend migrate command to migrate the backend state from the old-unit-name unit to the new-unit-name unit.

cp -R old-unit-name new-unit-name
terragrunt backend migrate old-unit-name new-unit-name
rm -rf old-unit-name

This will migrate the backend state from the old-unit-name unit to the new-unit-name unit, and then delete the old-unit-name unit.

Terragrunt performs migrations in one of two ways, depending on the level of support for the backends being migrated, and the state of configuration between the two units.

1. If the backend source for both the source and destination units are the same (both are S3 or GCS), Terragrunt will use the AWS/GCP SDK to move state between the two units transparently without interacting with OpenTofu/Terraform. This is the preferred method, when possible.
2. If either backend source isn’t supported by Terragrunt, or the state of configuration between the two units is different, Terragrunt will instead use the OpenTofu/Terraform CLI to move the state between the two units. This is the fallback method, and will generally be slower. Terragrunt also won’t be able to delete the existing state from the source unit in this case, so you’ll need to handle that yourself.

Flags:

• --config: Path to the Terragrunt configuration file to use to migrate the resources.
• --download-dir: Path to download OpenTofu/Terraform modules into. The default is .terragrunt-cache.
• --force: Force the migration of the backend state file. By default, Terragrunt will refuse to migrate the backend state file if the source bucket does not have versioning enabled.

HCL commands

hcl validate

Find all hcl files from the configuration stack and validate them.

Example:

terragrunt hcl validate

This will search all hcl files from the configuration stack in the current working directory and run the equivalent of tofu validate/terraform validate on them.

For convenience in programmatically parsing these findings, you can also pass the --json flag to output the results in JSON format.

Example:

terragrunt hcl validate --json

In addition, you can pass the --show-config-path flag to only output paths of the invalid config files, delimited by newlines. This can be especially useful when combined with the queue-excludes-file flag.

Example:

terragrunt hcl validate --show-config-path

Using the --inputs flag helps emit information about the input variables that are configured with the given terragrunt configuration. The flag will print out unused inputs (inputs that are not defined as an OpenTofu/Terraform variable in the corresponding module) and undefined required inputs (required OpenTofu/Terraform variables that are not currently being passed in).

Example:

> terragrunt hcl validate --inputs
The following inputs passed in by terragrunt are unused:

    - foo
    - bar


The following required inputs are missing:

    - baz

Note that this only checks for variables passed in in the following ways:

• Configured inputs attribute.

• var files defined on terraform.extra_arguments blocks using required_var_files and optional_var_files.

• -var-file and -var CLI arguments defined on terraform.extra_arguments using arguments.

• -var-file and -var CLI arguments passed to terragrunt.

• Automatically loaded var files (terraform.tfvars, terraform.tfvars.json, *.auto.tfvars, *.auto.tfvars.json)

• TF_VAR environment variables defined on terraform.extra_arguments blocks.

• TF_VAR environment variables defined in the environment.

Be aware that other ways to pass variables to tofu/terraform are not checked by this command.

Additionally, there are two modes in which the hcl validate --inputs command can be run: relaxed (default) and strict.

If you run the hcl validate --inputs command without --strict flag, relaxed mode will be enabled by default. In relaxed mode, any unused variables that are passed, but not used by the underlying OpenTofu/Terraform configuration, will generate a warning, but not an error. Missing required variables will always return an error, whether hcl validate --inputs is running in relaxed or strict mode.

To enable strict mode, you can pass the --strict flag like so:

terragrunt hcl validate --inputs --strict

When running in strict mode, hcl validate --inputs will return an error if there are unused inputs.

This command will exit with an error if terragrunt detects any unused inputs or undefined required inputs.

hcl format

Recursively find hcl files and rewrite them into a canonical format.

Example:

terragrunt hcl fmt

This will recursively search the current working directory for any folders that contain Terragrunt configuration files and run the equivalent of tofu fmt/terraform fmt on them.

Catalog commands

catalog

Launch the user interface for searching and managing your module catalog.

More details in catalog section.

scaffold

Generate Terragrunt files from existing OpenTofu/Terraform modules.

More details in scaffold section.

Discovery commands

find

Find Terragrunt configurations in your codebase.

terragrunt find [options]

The find command helps you discover Terragrunt configurations in your codebase. It recursively searches for terragrunt.hcl and terragrunt.stack.hcl files and displays them in formatted output.

The find command is very similar to the list command. It uses the same discovery backend for configuration discovery. It also supports very similar flags and configuration options.

For example, you can use the --format flag to adjust the format of output. The find command also supports the --dependencies flag to include dependency information in the output, the --external flag to include external dependencies, and the --hidden flag to include hidden configurations.

It differs from the list command in that it is optimized for displaying configurations in a format that is easy for a computer to read and understand, so there are less configuration options, and the output is simpler. All output from the find command is structured such that results are in a flat list, making it easy to parse and process programmatically. Use the list command when you want to display configurations in a format that is easy for a human to read and understand.

Use the find command when you want to programmatically search for configurations in your codebase. Use the list command when you want to display configurations in a format that is easy for a human to read and understand.

When used without any flags, all units and stacks discovered in the current working directory are displayed in colorful text format.

Discovered configurations are color coded to help you identify them at a glance:

• Units are displayed in blue
• Stacks are displayed in green

You can disable color output by using the --no-color flag.

terragrunt find --no-color

When stdout is redirected, color output is disabled automatically to prevent undesired interference with other tools.

You can change the working directory used by the command by using the --working-dir flag.

terragrunt find --working-dir /path/to/working/dir

Find Output Format

In JSON format, find outputs a structured representation of the discovered configurations, including their types and path relative to the working directory.

$ terragrunt find --format=json | jq '.[:3]'
[
  {
    "type": "stack",
    "path": "basic"
  },
  {
    "type": "unit",
    "path": "basic/units/chick"
  },
  {
    "type": "unit",
    "path": "basic/units/chicken"
  }
]

Note that you can also use the --json flag to get the same output.

terragrunt find --json

Find DAG Mode

The find command supports DAG mode to sort output based on dependencies.

• --dag: Use DAG mode to sort output using the dependency graph.

When using DAG mode, configurations with no dependencies appear first, followed by configurations that depend on them, maintaining the correct dependency order.

$ terragrunt find --dag
unitA # no dependencies
unitB # no dependencies
unitC # depends on unitA
unitD # depends on unitC

Find Queue Construct As

The find command supports the --queue-construct-as flag to sort output based on the dependency graph, as if a particular command was run.

$ terragrunt find --queue-construct-as=plan
stacks/live/dev
stacks/live/prod
units/live/dev/vpc
units/live/prod/vpc
units/live/dev/db
units/live/prod/db
units/live/dev/ec2
units/live/prod/ec2

This will sort the output based on the dependency graph, as if the plan command was run. Meaning that all dependent units will appear after the units they depend on.

# Note that you can also use the shorter alias of the flag, `--as`.
$ terragrunt find --as=destroy
stacks/live/dev
stacks/live/prod
units/live/dev/ec2
units/live/prod/ec2
units/live/dev/db
units/live/prod/db
units/live/dev/vpc
units/live/prod/vpc

This will sort the output based on the dependency graph, as if the destroy command was run. Meaning that all dependent units will appear before the units they depend on.

Note: The --queue-construct-as flag implies the --dag flag.

Find Dependencies

You can include dependency information in the output using the --dependencies flag. When enabled, the JSON output will include the dependency relationships between configurations:

$ terragrunt find --dependencies --format=json | jq
[
  {
    "type": "unit",
    "path": "unitA",
    "dependencies": []
  },
  {
    "type": "unit",
    "path": "unitB",
    "dependencies": ["../unitA"]
  }
]

Find Include

You can also include include configuration in the output using the --include flag. When enabled, the JSON output will include the configurations of the include block in the discovered units.

$ terragrunt find --include --format=json | jq
[
  {
    "type": "unit",
    "path": "bar",
    "include": {
      "cloud": "cloud.hcl"
    }
  },
  {
    "type": "unit",
    "path": "foo"
  }
]

You can use tools like jq to filter the output and get all the units that include a specific configuration.

$ terragrunt find --include --format=json | jq '[.[] | select(.include.cloud == "cloud.hcl")]'
[
  {
    "type": "unit",
    "path": "bar",
    "include": {
      "cloud": "cloud.hcl"
    }
  }
]

Find Exclude

You can also include exclude configuration in the output using the --exclude flag. When enabled, the JSON output will include the configurations of the exclude block in the discovered units.

$ terragrunt find --exclude --format=json | jq
[
  {
    "type": "unit",
    "path": "action/exclude-apply",
    "exclude": {
      "exclude_dependencies": true,
      "actions": [
        "apply"
      ],
      "if": true
    }
  },
  {
    "type": "unit",
    "path": "action/exclude-plan",
    "exclude": {
      "exclude_dependencies": true,
      "actions": [
        "plan"
      ],
      "if": true
    }
  },
  {
    "type": "unit",
    "path": "all-except-output/app1",
    "exclude": {
      "exclude_dependencies": true,
      "actions": [
        "all_except_output"
      ],
      "if": true
    }
  }
]

Note that you can combine this with the --queue-construct-as flag to dry-run behavior relevant to excludes.

$ terragrunt find --exclude --queue-construct-as=plan --format=json | jq
[
  {
    "type": "unit",
    "path": "action/exclude-apply",
    "exclude": {
      "exclude_dependencies": true,
      "actions": [
        "apply"
      ],
      "if": true
    }
  }
]

find will remove any units that would match the exclude configuration.

Find External Dependencies

By default, external dependencies (those outside the working directory) are excluded. Use the --external flag to include them in the output:

$ terragrunt find --dependencies --external --format=json | jq
[
  {
    "type": "unit",
    "path": "internal/unitA",
    "dependencies": []
  },
  {
    "type": "unit",
    "path": "internal/unitB",
    "dependencies": ["../unitA", "../../external/unitC"]
  },
  {
    "type": "unit",
    "path": "external/unitC",
    "dependencies": []
  }
]

Find Hidden Configurations

By default, hidden directories (those starting with .) are excluded from the search. Use --hidden to include them.

terragrunt find --hidden

list

List Terragrunt configurations in your codebase.

terragrunt list [options]

The list command helps you discover and display Terragrunt configurations in your codebase. It provides various output formats and options to help you understand the structure and dependencies of your Terragrunt configurations.

The list command is very similar to the find command. It uses the same backend logic for configuration discovery. It also supports very similar flags and configuration options.

For example, you can use the --format flags to adjust the format of output. The list command also supports the --dependencies flag to include dependency information in output when available, the --external flag to include external dependencies, and the --hidden flag to include hidden configurations.

It also uses global flags, such as --working-dir and --no-color to control behavior, and will avoid emitting color output when stdout is redirected. To save space here, common behavior between the find and list commands may be omitted from the list documentation. This documentation will focus on the differentiating features of the list command.

Generally, the list command is optimized for displaying configurations in a format that is easy for a human to read and understand, so there are more configuration options, and the output is more verbose. Output from the list command can vary significantly depending on the flags used, and the output structure is more variable than that of the find command.

Use the list command when you want to visualize your Terragrunt configurations in a human-readable format. Use the find command when you want to programmatically search for configurations in your codebase.

List Output Format

The list command supports multiple output formats to help you visualize your Terragrunt configurations in different ways.

Text Format (Default)

The default text format provides a simple, space-separated list of configurations:

The list command will display as many configurations as it can on a given line, wrapping around to the next line if necessary based on terminal width.

Long Format

The long format provides additional details about each configuration, including its type:

Tree Format

The tree format provides a hierarchical view of your configurations as a tree:

DAG Mode

The list command supports DAG mode to sort and group output based on dependencies.

• --dag: Use DAG mode to sort and group output using the dependency graph.

When using DAG mode, configurations with no dependencies appear first, followed by configurations that depend on them, maintaining the correct dependency order.

By default, configurations are sorted alphabetically:

$ terragrunt list
a-dependent b-dependency

You can sort configurations based on their dependency relationships using the --dag option:

$ terragrunt list --dag
b-dependency a-dependent

Normally, the tree format will display configurations ordered by name, and grouped by directory:

$ terragrunt list --tree
.
╰── live
    ├── dev
    │   ├── db
    │   ├── ec2
    │   ╰── vpc
    ╰── prod
        ├── db
        ├── ec2
        ╰── vpc

When using --dag with the tree format, configurations are sorted by dependency order, and grouped by relationship in the dependency graph:

$ terragrunt list --tree --dag
.
├── live/dev/vpc
│   ├── live/dev/db
│   │   ╰── live/dev/ec2
│   ╰── live/dev/ec2
╰── live/prod/vpc
    ├── live/prod/db
    │   ╰── live/prod/ec2
    ╰── live/prod/ec2

List Queue Construct As

Just like the find command, the list command supports the --queue-construct-as flag to sort output based on the dependency graph, as if a particular command was run.

$ terragrunt list --queue-construct-as=plan
stacks/live/dev      stacks/live/prod     units/live/dev/vpc
units/live/prod/vpc  units/live/dev/db    units/live/prod/db
units/live/dev/ec2   units/live/prod/ec2

This will sort the output based on the dependency graph, as if the plan command was run. Meaning that all dependent units will appear after the units they depend on.

$ terragrunt list --queue-construct-as=destroy
stacks/live/dev      stacks/live/prod     units/live/dev/ec2
units/live/prod/ec2  units/live/dev/db    units/live/prod/db
units/live/dev/vpc   units/live/prod/vpc

This will sort the output based on the dependency graph, as if the destroy command was run. Meaning that all dependent units will appear before the units they depend on.

Note: The --queue-construct-as flag implies the --dag flag.

Configuration commands

render

Render the Terragrunt configuration in the current working directory, with as much work done as possible beforehand (that is, with all includes merged, dependencies resolved/interpolated, function calls executed, etc).

Example:

The following terragrunt.hcl:

locals {
  aws_region = "us-east-1"
}

inputs = {
  aws_region = local.aws_region
}

Renders to the following HCL by default:

$ terragrunt render
locals {
  aws_region = "us-east-1"
}
inputs = {
  aws_region = "us-east-1"
}

Note the resolution of the aws_region local, making it easier to read the final evaluated configuration at a glance.

Renders to the following JSON when the --format json flag is used:

$ terragrunt render --format json
{
  "locals": { "aws_region": "us-east-1" },
  "inputs": { "aws_region": "us-east-1" }
  // NOTE: other attributes are omitted for brevity
}

You can also use the --write flag to write the rendered configuration to a canonically named file in the same working directory as the terragrunt.hcl file.

Example:

# Note the use of the `--json` shortcut flag.
terragrunt render --json --write

This will write the rendered configuration to terragrunt.rendered.json in the current working directory.

This can be useful when rendering many configurations in a given directory, and you want to keep the rendered configurations in the same directory as the original configurations, without leveraging external tools or scripts.

This is also useful when combined with the --all flag, which will render all configurations discovered from the current working directory.

# Note the use of the `-w` alias for the `--write` flag.
terragrunt render --all --json -w

This will render all configurations discovered from the current working directory and write the rendered configurations to terragrunt.rendered.json files adjacent to the configurations they are derived from.

info

The info command is used to display information about Terragrunt settings.

It will soon replace the terragrunt-info command. See the CLI Redesign documentation for more information.

Strict command

Displays current strict controls.

Example:

terragrunt info strict

You can also view detailed information on a specific control by specifying its name in the command line.

Example:

terragrunt info strict deprecated-flags

Print command

Print out a short description of the current Terragrunt context.

Example:

terragrunt info print

This command outputs a JSON object that includes useful contextual information such as the path to the configuration file, working directory, download cache location, the IAM role in use, and the Terraform (or Tofu) binary being invoked.

Example output:

{
  "config_path": "/example/path/terragrunt.hcl",
  "download_dir": "/example/path/.terragrunt-cache",
  "iam_role": "",
  "terraform_binary": "tofu",
  "terraform_command": "print",
  "working_dir": "/example/path"
}

dag

The dag command is used to interact with the Directed Acyclic Graph.

It will soon replace the graph-dependencies command. See the CLI Redesign documentation for more information.

dag graph

Print a visual representation of the Terragrunt dependency graph in DOT language format. This command analyzes your Terragrunt configuration and outputs a directed acyclic graph (DAG) showing the relationships and dependencies between your Terraform modules.

Example usage:

terragrunt dag graph

The output can be piped to Graphviz tools to generate visual diagrams:

terragrunt dag graph  | dot -Tpng > graph.png

Flags

• Flags
  • all
  • graph
  • auth-provider-cmd
  • config
  • tf-path
  • no-auto-init
  • no-auto-approve
  • no-auto-retry
  • non-interactive
  • working-dir
  • download-dir
  • source
  • source-map
  • source-update
  • summary-disable
  • iam-assume-role
  • iam-assume-role-duration
  • iam-assume-role-session-name
  • iam-assume-role-web-identity-token
  • queue-ignore-errors
  • queue-excludes-file
  • queue-exclude-dir
  • queue-include-dir
  • queue-strict-include
  • queue-ignore-dag-order
  • queue-exclude-external
  • queue-include-external
  • strict-validate
  • parallelism
  • inputs-debug
  • log-level
  • log-format
  • log-custom-format
  • log-disable
  • log-show-abs-paths
  • no-color
  • check
  • diff
  • hclfmt-file
  • hclfmt-exclude-dir
  • hclfmt-stdin
  • hclvalidate-json
  • hclvalidate-show-config-path
  • disable-dependent-modules
  • out
  • units-that-include
  • queue-include-units-reading
  • dependency-fetch-output-from-state
  • use-partial-parse-config-cache
  • backend-require-bootstrap
  • disable-bucket-update
  • disable-command-validation
  • provider-cache
  • provider-cache-dir
  • provider-cache-hostname
  • provider-cache-port
  • provider-cache-token
  • provider-cache-registry-names
  • out-dir
  • json-out-dir
  • tf-forward-stdout
  • no-destroy-dependencies-check
  • feature
  • experiment
  • experiment-mode
  • strict-control
  • strict-mode
  • in-download-dir

all

CLI Arg: --all
CLI Alias: -a
Environment Variable: TG_ALL (set to true)

This is equivalent to the soon to be deprecated run-all command.

Runs the provided OpenTofu/Terraform command against a stack. The command will recursively find terragrunt units in the current directory tree and run the OpenTofu/Terraform command in dependency order (unless the command is destroy, in which case the command is run in reverse dependency order).

Make sure to read about the stacks feature for context.

Example:

terragrunt run --all apply

This will recursively search the current working directory for any folders that contain Terragrunt units and run apply in each one, concurrently, while respecting ordering defined via dependency and dependencies blocks.

[WARNING] Do not set TF_PLUGIN_CACHE_DIR when using run --all

Instead take advantage of the built-in Provider Cache Server that mitigates some of the limitations of using the OpenTofu/Terraform Provider Plugin Cache directly.

We are working with the OpenTofu team to improve this behavior so that you don’t have to worry about this in the future.

[NOTE] Use run --all with care if you have unapplied dependencies.

If you have a stack of Terragrunt units with dependencies between them via dependency blocks and you’ve never deployed them, then commands like run --all plan will fail, as it won’t be possible to resolve outputs of dependency blocks without applying them first.

The solution for this is to take advantage of mock outputs in dependency blocks.

[NOTE] Using run --all with apply or destroy silently adds the -auto-approve flag to the command line arguments passed to OpenTofu/Terraform due to issues with shared stdin making individual approvals impossible.

[NOTE] Using the OpenTofu/Terraform -detailed-exitcode flag with the run --all command results in an aggregate exit code being returned, rather than the exit code of any particular unit.

The algorithm for determining the aggregate exit code is as follows:

• If any unit throws a 1, Terragrunt will throw a 1.
• If any unit throws a 2, but nothing throws a 1, Terragrunt will throw a 2.
• If nothing throws a non-zero, Terragrunt will throw a 0.

graph

CLI Arg: --graph
Environment Variable: TG_GRAPH

This is equivalent to the soon to be deprecated graph command.

Run the provided OpenTofu/Terraform command against the graph of dependencies for the unit in the current working directory. The graph consists of all units that depend on the unit in the current working directory via a dependency or dependencies blocks, plus all the units that depend on those units, and all the units that depend on those units, and so on, recursively up the tree, up to the Git repository root, or the path specified via the optional --graph-root argument.

The Command will be executed following the order of dependencies: so it’ll run on the unit in the current working directory first, then on units that depend on it directly, then on the units that depend on those units, and so on. Note that if the command is destroy, it will run in the opposite order (the final dependents, then their dependencies, etc. up to the unit you ran the command in).

Example: Having below dependencies:

Running terragrunt run --graph apply in eks module will lead to the following execution order:

Group 1
- Module project/eks

Group 2
- Module project/services/eks-service-1
- Module project/services/eks-service-2

Group 3
- Module project/services/eks-service-2-v2
- Module project/services/eks-service-3
- Module project/services/eks-service-5

Group 4
- Module project/services/eks-service-3-v2
- Module project/services/eks-service-4

Group 5
- Module project/services/eks-service-3-v3

Notes:

• lambda units aren’t included in the graph, because they are not dependent on eks unit.
• execution is from bottom up based on dependencies

Running terragrunt run --graph destroy in eks unit will lead to the following execution order:

Group 1
- Module project/services/eks-service-2-v2
- Module project/services/eks-service-3-v3
- Module project/services/eks-service-4
- Module project/services/eks-service-5

Group 2
- Module project/services/eks-service-3-v2

Group 3
- Module project/services/eks-service-3

Group 4
- Module project/services/eks-service-1
- Module project/services/eks-service-2

Group 5
- Module project/eks

Notes:

• execution is in reverse order, first are destroyed “top” units and in the end eks
• lambda units aren’t affected at all

Running terragrunt run --graph apply in services/eks-service-3:

Group 1
- Module project/services/eks-service-3

Group 2
- Module project/services/eks-service-3-v2
- Module project/services/eks-service-4

Group 3
- Module project/services/eks-service-3-v3

Notes:

• in execution are included only services dependent from eks-service-3

Running terragrunt run --graph destroy in services/eks-service-3:

Group 1
- Module project/services/eks-service-3-v3
- Module project/services/eks-service-4

Group 2
- Module project/services/eks-service-3-v2

Group 3
- Module project/services/eks-service-3

Notes:

• destroy will be executed only on subset of services dependent from eks-service-3

auth-provider-cmd

CLI Arg: --auth-provider-cmd
CLI Arg Alias: --terragrunt-auth-provider-cmd (deprecated: See migration guide)
Environment Variable: TG_AUTH_PROVIDER_CMD
Environment Variable Alias: TERRAGRUNT_AUTH_PROVIDER_CMD (deprecated: See migration guide)
Requires an argument: --auth-provider-cmd "command [arguments]"

The command and arguments used to obtain authentication credentials dynamically. If specified, Terragrunt runs this command whenever it might need authentication. This includes HCL parsing, where it might be useful to authenticate with a cloud provider before running HCL functions like get_aws_account_id where authentication has to already have taken place. It can also be useful for HCL functions like run_cmd where it may be useful to be authenticated before calling the function.

The output must be valid JSON of the following schema:

{
  "awsCredentials": {
    "ACCESS_KEY_ID": "",
    "SECRET_ACCESS_KEY": "",
    "SESSION_TOKEN": ""
  },
  "awsRole": {
    "roleARN": "",
    "sessionName": "",
    "duration": 0,
    "webIdentityToken": ""
  },
  "envs": {
    "ANY_KEY": ""
  }
}

This allows Terragrunt to acquire different credentials at runtime without changing any terragrunt.hcl configuration. You can use this flag to set arbitrary credentials for continuous integration, authentication with providers other than AWS and more.

As long as the standard output of the command passed to auth-provider-cmd results in JSON matching the schema above, corresponding environment variables will be set (and/or roles assumed) before Terragrunt begins parsing an terragrunt.hcl file or running an OpenTofu/Terraform command.

The simplest approach to leverage this flag is to write a script that fetches desired credentials, and emits them to STDOUT in the JSON format listed above:

#!/usr/bin/env bash

echo -n '{"envs": {"KEY": "a secret"}}'

You can use any technology for the authentication provider you’d like, however, as long as Terragrunt can execute it. The expected pattern for using this flag is to author a script/program that will dynamically fetch secret values from a secret store, etc. then emit them to STDOUT for consumption by Terragrunt.

Note that more specific configurations (e.g. awsCredentials) take precedence over less specific configurations (e.g. envs).

If you would like to set credentials for AWS with this method, you are encouraged to use awsCredentials instead of envs, as these keys will be validated to conform to the officially supported environment variables expected by the AWS SDK.

Similarly, if you would like Terragrunt to assume an AWS role on your behalf, you are encouraged to use the awsRole configuration instead of envs.

Other credential configurations will be supported in the future, but until then, if your provider authenticates via environment variables, you can use the envs field to fetch credentials dynamically from a secret store, etc before Terragrunt executes any IAC.

Note: The awsRole configuration is only used when the awsCredentials configuration is not present. If both are present, the awsCredentials configuration will take precedence.

config

CLI Arg: --config
CLI Arg Alias: --terragrunt-config (deprecated: See migration guide)
Environment Variable: TG_CONFIG
Environment Variable Alias: TERRAGRUNT_CONFIG (deprecated: See migration guide)
Requires an argument: --config /path/to/terragrunt.hcl

A custom path to the terragrunt.hcl or terragrunt.hcl.json file. The default path is terragrunt.hcl (preferred) or terragrunt.hcl.json in the current directory (see Configuration for a slightly more nuanced explanation). This argument is not used with run --all commands.

tf-path

CLI Arg: --tf-path
CLI Arg Alias: --terragrunt-tfpath (deprecated: See migration guide)
Environment Variable: TG_TF_PATH
Environment Variable Alias: TERRAGRUNT_TFPATH (deprecated: See migration guide)
Requires an argument: --tf-path /path/to/tofu-or-terraform-binary

An explicit path to the tofu or terraform binary you wish to have Terragrunt use.

Note that if you only have terraform installed, and available in your PATH, Terragrunt will automatically use that binary.

If you have both terraform and tofu installed, and you want to use terraform, you can set the TG_TF_PATH to terraform.

If you have multiple versions of tofu and/or terraform available, or you have a custom wrapper for tofu or terraform, you can set the TG_TF_PATH to the absolute path of the executable you want to use.

NOTE: This will override the terraform binary that is used by terragrunt in all instances, including dependency lookups. This setting will also override any terraform_binary configuration values specified in the terragrunt.hcl config for both the top level, and dependency lookups.

no-auto-init

CLI Arg: --no-auto-init
CLI Arg Alias: --terragrunt-no-auto-init (deprecated: See migration guide)
Environment Variable: TG_NO_AUTO_INIT (set to true)
Environment Variable Alias: TERRAGRUNT_NO_AUTO_INIT (deprecated: See migration guide)
(Prior to Terragrunt v0.48.6, this environment variable was called TERRAGRUNT_AUTO_INIT (set to false), and is still available for backwards compatibility)

When passed in, don’t automatically run terraform init when other commands are run (e.g. terragrunt apply). Useful if you want to pass custom arguments to terraform init that are specific to a user or execution environment, and therefore cannot be specified as extra_arguments. For example, -plugin-dir. You must run terragrunt init yourself in this case if needed. terragrunt will fail if it detects that init is needed, but auto init is disabled. See Auto-Init

no-auto-approve

CLI Arg: --no-auto-approve
CLI Arg Alias: --terragrunt-no-auto-approve (deprecated: See migration guide)
Environment Variable: TG_NO_AUTO_APPROVE (set to true)
Environment Variable Alias: TERRAGRUNT_NO_AUTO_APPROVE (deprecated: See migration guide)
(Prior to Terragrunt v0.48.6, this environment variable was called TERRAGRUNT_AUTO_APPROVE (set to false), and is still available for backwards compatibility)

When passed in, Terragrunt will no longer automatically append -auto-approve to the underlying OpenTofu/Terraform commands run with run --all. Note that due to the interactive prompts, this flag will also automatically assume --parallelism 1.

no-auto-retry

CLI Arg: --no-auto-retry
CLI Arg Alias: --terragrunt-no-auto-retry (deprecated: See migration guide)
Environment Variable: TG_NO_AUTO_RETRY (set to true)
Environment Variable Alias: TERRAGRUNT_NO_AUTO_RETRY (deprecated: See migration guide)
(Prior to Terragrunt v0.48.6, this environment variable was called TERRAGRUNT_AUTO_RETRY (set to false), and is still available for backwards compatibility)

When passed in, don’t automatically retry commands which fail with transient errors. See Feature Flags, Errors and Excludes

non-interactive

CLI Arg: --non-interactive
CLI Arg Alias: --terragrunt-non-interactive (deprecated: See migration guide)
Environment Variable: TG_NON_INTERACTIVE (set to true)
Environment Variable Alias: TERRAGRUNT_NON_INTERACTIVE (deprecated: See migration guide)
(Prior to Terragrunt v0.48.6, this environment variable was called TF_INPUT (set to false), and is still available for backwards compatibility. NOTE: TF_INPUT is native to OpenTofu/Terraform!)

When passed in, don’t show interactive user prompts. This will default the answer for all Terragrunt (not OpenTofu/Terraform) prompts to yes except for the listed cases below. This is useful if you need to run Terragrunt in an automated setting (e.g. from a script). May also be specified with the TF_INPUT environment variable.

This setting will default to no for the following cases:

• Prompts related to pulling in external dependencies. You can force include external dependencies using the –queue-include-external option.

Note that this does not impact the behavior of OpenTofu/Terraform commands invoked by Terragrunt.

e.g.

terragrunt --non-interactive apply -auto-approve

Is how you would make Terragrunt apply without any user prompts from Terragrunt or OpenTofu/Terraform.

working-dir

CLI Arg: --working-dir
CLI Arg Alias: --terragrunt-working-dir (deprecated: See migration guide)
Environment Variable: TG_WORKING_DIR
Environment Variable Alias: TERRAGRUNT_WORKING_DIR (deprecated: See migration guide)
Requires an argument: --working-dir /path/to/working-directory

Set the directory where Terragrunt should execute the terraform command. Default is the current working directory. Note that for the run --all commands, this parameter has a different meaning: Terragrunt will apply or destroy all the OpenTofu/Terraform modules in the subfolders of the working-dir, running terraform in the root of each module it finds.

download-dir

CLI Arg: --download-dir
CLI Arg Alias: --terragrunt-download-dir (deprecated: See migration guide)
Environment Variable: TG_DOWNLOAD_DIR
Environment Variable Alias: TERRAGRUNT_DOWNLOAD (deprecated: See migration guide)
Requires an argument: --download-dir /path/to/dir-to-download-terraform-code

The path where to download OpenTofu/Terraform code when using remote OpenTofu/Terraform configurations. Default is .terragrunt-cache in the working directory. We recommend adding this folder to your .gitignore.

source

CLI Arg: --source
CLI Arg Alias: --terragrunt-source (deprecated: See migration guide)
Environment Variable: TG_SOURCE
Environment Variable Alias: TERRAGRUNT_SOURCE (deprecated: See migration guide)
Requires an argument: --source /path/to/local-terraform-code

Download OpenTofu/Terraform configurations from the specified source into a temporary folder, and run OpenTofu/Terraform in that temporary folder. The source should use the same syntax as the OpenTofu/Terraform module source parameter. If you specify this argument for the run --all commands, Terragrunt will assume this is the local file path for all of your OpenTofu/Terraform modules, and for each module processed by the run --all command, Terragrunt will automatically append the path of source parameter in each module to the --source parameter you passed in.

source-map

CLI Arg: --source-map
CLI Arg Alias: --terragrunt-source-map (deprecated: See migration guide)
Environment Variable: TG_SOURCE_MAP (encoded as comma separated value, e.g., source1=dest1,source2=dest2)
Environment Variable Alias: TERRAGRUNT_SOURCE_MAP (deprecated: See migration guide)
Requires an argument: --source-map git::ssh://github.com=/path/to/local-terraform-code

Can be supplied multiple times: --source-map source1=dest1 --source-map source2=dest2

The --source-map source=dest param replaces any source URL (including the source URL of a config pulled in with dependency blocks) that has root source with dest.

For example:

terragrunt apply --source-map github.com/org/modules.git=/local/path/to/modules

The above would replace terraform { source = "github.com/org/modules.git//xxx" } with terraform { source = /local/path/to/modules//xxx } regardless of whether you were running apply, or run --all, or using a dependency.

NOTE: This setting is ignored if you pass in --source.

Note that this only performs literal matches on the URL portion. For example, a map key of ssh://git@github.com/gruntwork-io/terragrunt.git will only match terragrunt configurations with source source = "ssh://git@github.com/gruntwork-io/terragrunt.git//xxx" and not sources of the form source = "git::ssh://git@github.com/gruntwork-io/terragrunt.git//xxx". The latter requires a map key of git::ssh://git@github.com/gruntwork-io/terragrunt.git.

source-update

CLI Arg: --source-update
CLI Arg Alias: --terragrunt-source-update (deprecated: See migration guide)
Environment Variable: TG_SOURCE_UPDATE (set to true)
Environment Variable Alias: TERRAGRUNT_SOURCE_UPDATE (deprecated: See migration guide)

When passed in, delete the contents of the temporary folder before downloading OpenTofu/Terraform source code into it.

report-file

CLI Arg: --report-file
Environment Variable: TG_REPORT_FILE
Requires an argument: --report-file /path/to/report-file

When passed in, a report of the run will be generated at the specified path.

Note that, by default, the format of the report will be inferred from the file extension. If no extension is specified, CSV will be used by default. Use the report-format flag to explicitly specify the format of the report.

For more information, see the Run Report feature.

report-format

CLI Arg: --report-format
Environment Variable: TG_REPORT_FORMAT
Requires an argument: --report-format <FORMAT>

The format of the report.

The supported formats are:

• csv
• json

The default is csv.

For more information, see the Run Report feature.

report-schema-file

CLI Arg: --report-schema-file
Environment Variable: TG_REPORT_SCHEMA_FILE
Requires an argument: --report-schema-file /path/to/report-schema-file

When passed in, a JSON schema for the report will be generated at the specified path.

For more information, see the Run Report feature.

summary-disable

CLI Arg: --summary-disable
Environment Variable: TG_SUMMARY_DISABLE (set to true)

When passed in, disable the summary output at the end of a run.

For more information, see the Run Report feature.

summary-per-unit

CLI Arg: --summary-per-unit
Environment Variable: TG_SUMMARY_PER_UNIT

When enabled, Terragrunt will break down the run summary by unit. The units are sorted by result, then duration, with the longest-running units shown first.

For more information, see the Run Report feature.

iam-assume-role

CLI Arg: --iam-assume-role
CLI Arg Alias: --terragrunt-iam-role (deprecated: See migration guide)
Environment Variable: TG_IAM_ASSUME_ROLE
Environment Variable Alias: TERRAGRUNT_IAM_ROLE (deprecated: See migration guide)
Requires an argument: --iam-assume-role "arn:aws:iam::ACCOUNT_ID:role/ROLE_NAME"

Assume the specified IAM role ARN before running OpenTofu/Terraform or AWS commands. This is a convenient way to use Terragrunt and OpenTofu/Terraform with multiple AWS accounts.

When using this option, AWS authentication takes place right before an OpenTofu/Terraform run. This takes place after terragrunt.hcl files are fully parsed, so HCL functions like get_aws_account_id and run_cmd will not run after assuming the role. If you need roles to be assumed prior to parsing Terragrunt configurations, use auth-provider-cmd instead.

iam-assume-role-duration

CLI Arg: --iam-assume-role-duration
CLI Arg Alias: --terragrunt-iam-assume-role-duration (deprecated: See migration guide)
Environment Variable: TG_IAM_ASSUME_ROLE_DURATION
Environment Variable Alias: TERRAGRUNT_IAM_ASSUME_ROLE_DURATION (deprecated: See migration guide)
Requires an argument: --iam-assume-role-duration 3600

Uses the specified duration as the session duration (in seconds) for the STS session which assumes the role defined in --iam-assume-role.

iam-assume-role-session-name

CLI Arg: --iam-assume-role-session-name
CLI Arg Alias: --terragrunt-iam-assume-role-session-name (deprecated: See migration guide)
Environment Variable: TG_IAM_ASSUME_ROLE_SESSION_NAME
Environment Variable Alias: TERRAGRUNT_IAM_ASSUME_ROLE_SESSION_NAME (deprecated: See migration guide)
Requires an argument: --iam-assume-role-session-name "terragrunt-iam-role-session-name"

Used as the session name for the STS session which assumes the role defined in --iam-assume-role.

iam-assume-role-web-identity-token

CLI Arg: --iam-assume-role-web-identity-token
CLI Arg Alias: --terragrunt-iam-web-identity-token (deprecated: See migration guide)
Environment Variable: TG_IAM_ASSUME_ROLE_WEB_IDENTITY_TOKEN
Environment Variable Alias: TERRAGRUNT_IAM_ASSUME_ROLE_WEB_IDENTITY_TOKEN (deprecated: See migration guide)
Requires an argument: --iam-assume-role-web-identity-token [/path/to/web-identity-token | web-identity-token-value]

Used as the web identity token for assuming a role temporarily using the AWS Security Token Service (STS) with the AssumeRoleWithWebIdentity API.

queue-ignore-errors

CLI Arg: --queue-ignore-errors
CLI Arg Alias: --terragrunt-ignore-dependency-errors (deprecated: See migration guide)
Environment Variable: TG_QUEUE_IGNORE_ERRORS
Environment Variable Alias: TERRAGRUNT_IGNORE_DEPENDENCY_ERRORS (deprecated: See migration guide)

When passed in, the *-all commands continue processing components even if a dependency fails

queue-excludes-file

CLI Arg: --queue-excludes-file
CLI Arg Alias: --terragrunt-excludes-file (deprecated: See migration guide)
Environment Variable: TG_QUEUE_EXCLUDES_FILE
Environment Variable Alias: TERRAGRUNT_EXCLUDES_FILE (deprecated: See migration guide)
Requires an argument: --queue-excludes-file /path/to/file

Path to a file with a list of directories that need to be excluded when running *-all commands, by default .terragrunt-excludes. Modules under these directories will be excluded during execution of the commands. If a relative path is specified, it should be relative from –working-dir. This will only exclude the module, not its dependencies.

This flag has been designed to integrate nicely with the hclvalidate command, which can return a list of invalid files delimited by newlines when passed the --show-config-path flag. To integrate the two, you can run something like the following using bash process substitution:

terragrunt run --all plan --queue-excludes-file <(terragrunt hclvalidate --show-config-path)

queue-exclude-dir

CLI Arg: --queue-exclude-dir
CLI Arg Alias: --terragrunt-exclude-dir (deprecated: See migration guide)
Environment Variable: TG_QUEUE_EXCLUDE_DIR
Environment Variable Alias: TERRAGRUNT_EXCLUDE_DIR (deprecated: See migration guide)
Requires an argument: --queue-exclude-dir /path/to/dirs/to/exclude*

Can be supplied multiple times: --queue-exclude-dir /path/to/dirs/to/exclude --queue-exclude-dir /another/path/to/dirs/to/exclude

Unix-style glob of directories to exclude when running *-all commands. Modules under these directories will be excluded during execution of the commands. If a relative path is specified, it should be relative from –working-dir. Flag can be specified multiple times. This will only exclude the module, not its dependencies.

Please note that the glob curly braces expansion is not taken in account using environment variable unlike of its equivalent as a parameter on the command line. You should consider using TG_QUEUE_EXCLUDE_DIR="foo/module,bar/module" instead of TG_QUEUE_EXCLUDE_DIR="{foo,bar}/module".

queue-include-dir

CLI Arg: --queue-include-dir
CLI Arg Alias: --terragrunt-include-dir (deprecated: See migration guide)
Environment Variable: TG_QUEUE_INCLUDE_DIR
Environment Variable Alias: TERRAGRUNT_INCLUDE_DIR (deprecated: See migration guide)
Requires an argument: --queue-include-dir /path/to/dirs/to/include*

Can be supplied multiple times: --queue-include-dir /path/to/dirs/to/include --queue-include-dir /another/path/to/dirs/to/include

Unix-style glob of directories to include when running *-all commands. Only modules under these directories (and all dependent modules) will be included during execution of the commands. If a relative path is specified, it should be relative from --working-dir. Flag can be specified multiple times.

Please note that the glob curly braces expansion is not taken in account using environment variable unlike of its equivalent as a parameter on the command line. You should consider using TG_QUEUE_INCLUDE_DIR="foo/module,bar/module" instead of TG_QUEUE_INCLUDE_DIR="{foo,bar}/module".

queue-strict-include

CLI Arg: --queue-strict-include
CLI Arg Alias: --terragrunt-strict-include (deprecated: See migration guide)
Environment Variable: TG_QUEUE_STRICT_INCLUDE
Environment Variable Alias: TERRAGRUNT_STRICT_INCLUDE (deprecated: See migration guide)

When passed in, only modules under the directories passed in with –queue-include-dir will be included. All dependencies of the included directories will be excluded if they are not in the included directories. If no –queue-include-dir flags are included, terragrunt will not include any modules during the execution of the commands.

queue-ignore-dag-order

CLI Arg: --queue-ignore-dag-order
CLI Arg Alias: --terragrunt-ignore-dependency-order (deprecated: See migration guide)
Environment Variable: TG_QUEUE_IGNORE_DAG_ORDER
Environment Variable Alias: TERRAGRUNT_IGNORE_DEPENDENCY_ORDER (deprecated: See migration guide)

When passed in, ignore the dependencies between units when running *-all commands.

queue-exclude-external

CLI Arg: --queue-exclude-external
CLI Arg Alias: --terragrunt-ignore-external-dependencies (deprecated: See migration guide)
Environment Variable: TG_QUEUE_EXCLUDE_EXTERNAL
Environment Variable Alias: TERRAGRUNT_IGNORE_EXTERNAL_DEPENDENCIES (deprecated: See migration guide)

When passed in, don’t attempt to include any external dependencies when running *-all commands. Note that an external dependency is a dependency that is outside the current terragrunt working directory, and is not respective to the included directories with queue-include-dir.

queue-include-external

CLI Arg: --queue-include-external
CLI Arg Alias: --terragrunt-include-external-dependencies (deprecated: See migration guide)
Environment Variable: TG_QUEUE_INCLUDE_EXTERNAL
Environment Variable Alias: TERRAGRUNT_INCLUDE_EXTERNAL_DEPENDENCIES (deprecated: See migration guide)

When passed in, include any external dependencies when running *-all without asking. Note that an external dependency is a dependency that is outside the current terragrunt working directory, and is not respective to the included directories with queue-include-dir.

strict-validate

CLI Arg: --strict-validate
CLI Arg Alias: --terragrunt-strict-validate (deprecated: See migration guide)
Environment Variable: TG_STRICT_VALIDATE
Environment Variable Alias: TERRAGRUNT_STRICT_VALIDATE (deprecated: See migration guide)

When passed in, and running terragrunt validate-inputs, enables strict mode for the validate-inputs command. When strict mode is enabled, an error will be returned if any variables required by the underlying OpenTofu/Terraform configuration are not passed in, OR if any unused variables are passed in. By default, terragrunt validate-inputs runs in relaxed mode. In relaxed mode, an error is only returned when a variable required by the underlying OpenTofu/Terraform configuration is not passed in.

parallelism

CLI Arg: --parallelism
CLI Arg Alias: --terragrunt-parallelism (deprecated: See migration guide)
Environment Variable: TG_PARALLELISM
Environment Variable Alias: TERRAGRUNT_PARALLELISM (deprecated: See migration guide)

When passed in, limit the number of units that are run concurrently to this number during *-all commands. The exception is the terraform init command, which is always executed sequentially if the OpenTofu provider plugin cache is used. This is because the provider plugin cache is not guaranteed to be concurrency safe when used in isolation.

To safely access provider cache concurrently, enable the Provider Cache Server.

inputs-debug

CLI Arg: --inputs-debug
CLI Arg Alias: --terragrunt-debug (deprecated: See migration guide)
Environment Variable: TG_INPUTS_DEBUG
Environment Variable Alias: TERRAGRUNT_DEBUG (deprecated: See migration guide)

When passed in, Terragrunt will create a tfvars file that can be used to invoke the terraform module in the same way that Terragrunt invokes the module, so that you can debug issues with the terragrunt config. See Debugging for additional details.

log-level

CLI Arg: --log-level
CLI Arg Alias: --terragrunt-log-level (deprecated: See migration guide)
Environment Variable: TG_LOG_LEVEL
Environment Variable Alias: TERRAGRUNT_LOG_LEVEL (deprecated: See migration guide)
Requires an argument: --log-level <LOG_LEVEL>

When passed it, sets logging level for terragrunt. All supported levels are:

• stderr
• stdout
• error
• warn
• info (this is the default)
• debug
• trace

Where the first two control the logging of Terraform/OpenTofu output.

log-format

CLI Arg: --log-format
CLI Arg Alias: --terragrunt-log-format (deprecated: See migration guide)
Environment Variable: TG_LOG_FORMAT
Environment Variable Alias: TERRAGRUNT_LOG_FORMAT (deprecated: See migration guide)
Requires an argument: --log-format <LOG_FORMAT>

There are four log format presets:

• pretty (this is the default)
• bare (old Terragrunt logging, pre-v0.67.0)
• json
• key-value

log-custom-format

CLI Arg: --log-custom-format
CLI Arg Alias: --terragrunt-log-custom-format (deprecated: See migration guide)
Environment Variable: TG_LOG_CUSTOM_FORMAT
Environment Variable Alias: TERRAGRUNT_LOG_CUSTOM_FORMAT (deprecated: See migration guide)
Requires an argument: --log-custom-format <LOG_CUSTOM_FORMAT>

This allows you to customize logging however you like.

Make sure to read Custom Log Format for syntax details.

log-disable

CLI Arg: --log-disable
CLI Arg Alias: --terragrunt-log-disable (deprecated: See migration guide)
Environment Variable: TG_LOG_DISABLE
Environment Variable Alias: TERRAGRUNT_LOG_DISABLE (deprecated: See migration guide)

Disable logging. This flag also enables tf-forward-stdout.

log-show-abs-paths

CLI Arg: --log-show-abs-paths
CLI Arg Alias: --terragrunt-log-show-abs-paths (deprecated: See migration guide)
Environment Variable: TG_LOG_SHOW_ABS_PATHS
Environment Variable Alias: TERRAGRUNT_LOG_SHOW_ABS_PATHS (deprecated: See migration guide)

If specified, Terragrunt paths in logs will be absolute. By default, the paths are relative to the working directory.

no-color

CLI Arg: --no-color
CLI Arg Alias: --terragrunt-no-color (deprecated: See migration guide)
Environment Variable: TG_NO_COLOR
Environment Variable Alias: TERRAGRUNT_NO_COLOR (deprecated: See migration guide)

If specified, Terragrunt output won’t contain any color.

NOTE: This option also disables OpenTofu/Terraform output colors by propagating the OpenTofu/Terraform -no-color argument.

check

CLI Arg: --check
CLI Arg Alias: --terragrunt-check (deprecated: See migration guide)
Environment Variable: TG_CHECK (set to true)
Environment Variable Aliases: TERRAGRUNT_CHECK, TG_HCLFMT_CHECK (deprecated: See migration guide)
Commands:

• hclfmt

When passed in, run hclfmt in check only mode instead of actively overwriting the files. This will cause the command to exit with exit code 1 if there are any files that are not formatted.

diff

CLI Arg: --diff
CLI Arg Alias: --terragrunt-diff (deprecated: See migration guide)
Environment Variable: TG_DIFF (set to true)
Environment Variable Aliases: TERRAGRUNT_DIFF, TG_HCLFMT_DIFF (deprecated: See migration guide)
Commands:

• hclfmt

When passed in, running hclfmt will print diff between original and modified file versions.

hclfmt-file

CLI Arg: --file
CLI Arg Alias: --terragrunt-hclfmt-file (deprecated: See migration guide)
Environment Variable: TG_FILE
Environment Variable Aliases: TERRAGRUNT_FILE, TG_HCLFMT_FILE (deprecated: See migration guide)
Requires an argument: --file /path/to/terragrunt.hcl
Commands:

• hclfmt

When passed in, run hclfmt only on the specified file.

hclfmt-exclude-dir

CLI Arg: --exclude-dir
CLI Arg Alias: --terragrunt-hclfmt-exclude-dir (deprecated: See migration guide)
Environment Variable: TG_EXCLUDE_DIR
Environment Variable Aliases: TERRAGRUNT_EXCLUDE_DIR, TG_HCLFMT_EXCLUDE_DIR (deprecated: See migration guide)
Requires an argument: --exclude-dir /path/to/dir
Commands:

• hclfmt

Can be supplied multiple times: --exclude-dir .back --exclude-dir .archive
When passed in, hclfmt will ignore files in the specified directories.

hclfmt-stdin

CLI Arg: --stdin
CLI Arg Alias: --terragrunt-hclfmt-stdin (deprecated: See migration guide)
Environment Variable: TG_STDIN (set to true)
Environment Variable Aliases: TERRAGRUNT_STDIN, TG_HCLFMT_STDIN (deprecated: See migration guide)
Commands:

• hclfmt

When passed in, run hclfmt only on hcl passed to stdin, result is printed to stdout.

hclvalidate-json

CLI Arg: --json
CLI Arg Alias: --terragrunt-hclvalidate-json (deprecated: See migration guide)
Environment Variable: TG_JSON (set to true)
Environment Variable Aliases: TERRAGRUNT_JSON, TG_HCLVALIDATE_JSON (deprecated: See migration guide)
Commands:

• hclvalidate

When passed in, render the output in the JSON format.

hclvalidate-show-config-path

CLI Arg: --show-config-path
CLI Arg Alias: --terragrunt-hclvalidate-show-config-path (deprecated: See migration guide)
Environment Variable: TG_SHOW_CONFIG_PATH (set to true)
Environment Variable Aliases: TERRAGRUNT_SHOW_CONFIG_PATH, TG_HCLVALIDATE_SHOW_CONFIG_PATH (deprecated: See migration guide)
Commands:

• hclvalidate

When passed in, output a list of files with invalid configuration.

disable-dependent-modules

CLI Arg: --disable-dependent-modules
CLI Arg Alias: --terragrunt-json-disable-dependent-modules (deprecated: See migration guide)
Environment Variable: TG_RENDER_JSON_DISABLE_DEPENDENT_MODULES (set to true)
Environment Variable Alias: TERRAGRUNT_JSON_DISABLE_DEPENDENT_MODULES (deprecated: See migration guide)
Commands:

• render-json

When --disable-dependent-modules is set, the process of identifying dependent modules will be disabled during JSON rendering. This lead to a faster rendering process, but the output will not include any dependent units.

out

CLI Arg: --out
CLI Arg Alias: --terragrunt-json-out (deprecated: See migration guide)
Environment Variable: TG_OUT (set to true)
Environment Variable Alias: TERRAGRUNT_JSON_OUT (deprecated: See migration guide)
Requires an argument: --out /path/to/terragrunt_rendered.json
Commands:

• render-json

When passed in, render the json representation in this file.

units-that-include

CLI Arg: --units-that-include
CLI Arg Alias: --terragrunt-modules-that-include (deprecated: See migration guide)
Environment Variable: TG_UNITS_THAT_INCLUDE
Environment Variable Alias: TERRAGRUNT_MODULES_THAT_INCLUDE (deprecated: See migration guide)
Requires an argument: --units-that-include /path/to/included-terragrunt.hcl

When passed in, run --all will only run the command against Terragrunt modules that include the specified file.

This applies to the set of modules that are identified based on all the existing criteria for deciding which modules to include. For example, consider the following folder structure:

.
├── _envcommon
│   └── data-stores
│       └── aurora.hcl
├── dev
│   └── us-west-2
│       └── dev
│           ├── data-stores
│           │   └── aurora
│           │       └── terragrunt.hcl
│           └── networking
│               └── vpc
│                   └── terragrunt.hcl
└── stage
    └── us-west-2
        └── stage
            ├── data-stores
            │   └── aurora
            │       └── terragrunt.hcl
            └── networking
                └── vpc
                    └── terragrunt.hcl

Suppose that both dev/us-west-2/dev/data-stores/aurora/terragrunt.hcl and stage/us-west-2/stage/data-stores/aurora/terragrunt.hcl had the following contents:

include "envcommon" {
  path = "../../../../../_envcommon/data-stores/aurora.hcl"
}

If you run the command run --all init --units-that-include ../_envcommon/data-stores/aurora.hcl from the dev folder, only dev/us-west-2/dev/data-stores/aurora will be run; not stage/us-west-2/stage/data-stores/aurora. This is because run --all by default restricts the modules to only those that are direct descendents of the current folder you are running from. If you also pass in --queue-include-dir ../stage, then it will now include stage/us-west-2/stage/data-stores/aurora because now the stage folder is in consideration.

In other words, Terragrunt will always first find all the modules that should be included before applying this filter, and then will apply this filter on the set of modules that it found.

You can pass this argument in multiple times to provide a list of include files to consider. When multiple files are passed in, the set will be the union of modules that includes at least one of the files in the list.

NOTE: When using relative paths, the paths are relative to the working directory. This is either the current working directory, or any path passed in to working-dir.

TIP: This flag is functionally covered by the --queue-include-units-reading flag, but is more explicitly only for the include configuration block.

queue-include-units-reading

CLI Arg: --queue-include-units-reading
Environment Variable: TERRAGRUNT_QUEUE_INCLUDE_UNITS_READING
CLI Arg Alias: --terragrunt-queue-include-units-reading (deprecated: See migration guide)
Environment Variable Alias: TG_QUEUE_INCLUDE_UNITS_READING (deprecated: See migration guide)

This flag works very similarly to the --units-that-include flag, but instead of looking only for included configurations, it also looks for configurations that read a given file.

When passed in, the *-all commands will include all units (modules) that read a given file into the queue. This is useful when you want to trigger an update on all units that read or include a given file using HCL functions in their configurations.

Consider the following folder structure:

.
├── reading-shared-hcl
│   └── terragrunt.hcl
├── also-reading-shared-hcl
│   └── terragrunt.hcl
├── not-reading-shared-hcl
│   └── terragrunt.hcl
└── shared.hcl

Suppose that reading-shared-hcl and also-reading-shared-hcl both read shared.hcl in their configurations, like so:

locals {
 shared = read_terragrunt_config(find_in_parent_folders("shared.hcl"))
}

If you run the command run --all init --queue-include-units-reading shared.hcl from the root folder, both reading-shared-hcl and also-reading-shared-hcl will be run; not not-reading-shared-hcl.

This is because the read_terragrunt_config HCL function has a special hook that allows Terragrunt to track that it has read the file shared.hcl. This hook is used by all native HCL functions that Terragrunt supports which read files.

Note, however, that there are certain scenarios where Terragrunt may not be able to track that a file has been read this way.

For example, you may be using a bash script to read a file via run_cmd, or reading the file via OpenTofu code. To support these use-cases, the mark_as_read function can be used to manually mark a file as read.

That would look something like this:

locals {
  filename = mark_as_read("file-read-by-tofu.txt")
}

inputs = {
  filename = local.filename
}

⚠️: Due to the way that Terragrunt parses configurations during a run --all, functions will only properly mark files as read if they are used in the locals block. Reading a file directly in the inputs block will not mark the file as read, as the inputs block is not evaluated until after the queue has been populated with units to run.

dependency-fetch-output-from-state

CLI Arg: --dependency-fetch-output-from-state
CLI Arg Alias: --terragrunt-fetch-dependency-output-from-state (deprecated: See migration guide)
Environment Variable: TG_DEPENDENCY_FETCH_OUTPUT_FROM_STATE (set to true)
Environment Variable Alias: TERRAGRUNT_FETCH_DEPENDENCY_OUTPUT_FROM_STATE (deprecated: See migration guide)

When using many dependencies, this option can speed up the dependency processing by fetching dependency output directly from the state file instead of using tofu/terraform output to fetch them.

At this time, the only backend that supports this feature is the AWS S3 backend.

NOTE: Avoid using this flag without pinning the version of OpenTofu/Terraform you are using. There is no guarantee that OpenTofu/Terraform will maintain the existing schema of their state files, so there is also no guarantee that the flag will work as expected in future versions of OpenTofu/Terraform. They have not changed the schema of the state file in a long time, but there is no guarantee that they will not change it in the future. We are coordinating with the OpenTofu team to encourage stability in the state file schema, unless significant performance improvements can be made to OpenTofu output fetching to make this flag unnecessary.

Direct output fetching is a performance optimization. For more details on performance optimizations, their tradeoffs, and other performance tips, read the dedicated Performance documentation.

use-partial-parse-config-cache

CLI Arg: --use-partial-parse-config-cache
CLI Arg Alias: --terragrunt-use-partial-parse-config-cache (deprecated: See migration guide)
Environment Variable: TG_USE_PARTIAL_PARSE_CONFIG_CACHE (set to true)
Environment Variable Alias: TERRAGRUNT_USE_PARTIAL_PARSE_CONFIG_CACHE (deprecated: See migration guide)

This flag can be used to drastically decrease time required for parsing Terragrunt files. The effect will only show if a lot of similar includes are expected such as the root terragrunt configuration (e.g. root.hcl) include. NOTE: This is an experimental feature, use with caution.

The reason you might want to use this flag is that Terragrunt frequently only needs to perform a partial parse of Terragrunt configurations.

This is the case for scenarios like:

• Building the Directed Acyclic Graph (DAG) during a run --all command where only the dependency blocks need to be evaluated to determine run order.
• Parsing the terraform block to determine state configurations for fetching dependency outputs.
• Determining whether Terragrunt execution behavior has to change like for prevent_destroy or skip flags in configuration.

These configurations are generally safe to cache, but due to the nature of HCL being a dynamic configuration language, there are some edge cases where caching these can lead to incorrect behavior.

Once this flag has been tested thoroughly, we will consider making it the default behavior.

backend-require-bootstrap

CLI Arg: --backend-require-bootstrap
CLI Arg Alias: --terragrunt-fail-on-state-bucket-creation (deprecated: See migration guide)
Environment Variable: TG_BACKEND_REQUIRE_BOOTSTRAP (set to true)
Environment Variable Alias: TERRAGRUNT_FAIL_ON_STATE_BUCKET_CREATION (deprecated: See migration guide)

When this flag is set, Terragrunt will fail and exit if it is necessary to create the remote state bucket.

disable-bucket-update

CLI Arg: --disable-bucket-update
CLI Arg Alias: --terragrunt-disable-bucket-update (deprecated: See migration guide)
Environment Variable: TG_DISABLE_BUCKET_UPDATE (set to true)
Environment Variable Alias: TERRAGRUNT_DISABLE_BUCKET_UPDATE (deprecated: See migration guide)

When this flag is set, Terragrunt does not update the remote state bucket, which is useful to set if the state bucket is managed by a third party.

disable-command-validation

CLI Arg: --disable-command-validation
CLI Arg Alias: --terragrunt-disable-command-validation (deprecated: See migration guide)
Environment Variable: TG_DISABLE_COMMAND_VALIDATION (set to true)
Environment Variable Alias: TERRAGRUNT_DISABLE_COMMAND_VALIDATION (deprecated: See migration guide)

When this flag is set, Terragrunt will not validate the terraform command, which can be useful when need to use non-existent commands in hooks.

provider-cache

CLI Arg: --provider-cache
CLI Arg Alias: --terragrunt-provider-cache (deprecated: See migration guide)
Environment Variable: TG_PROVIDER_CACHE
Environment Variable Alias: TERRAGRUNT_PROVIDER_CACHE (deprecated: See migration guide)

Enables Terragrunt’s provider caching. This forces OpenTofu/Terraform to make provider requests through the Terragrunt Provider Cache server. Make sure to read Provider Cache Server for context.

provider-cache-dir

CLI Arg: --provider-cache-dir
CLI Arg Alias: --terragrunt-provider-cache-dir (deprecated: See migration guide)
Environment Variable: TG_PROVIDER_CACHE_DIR
Environment Variable Alias: TERRAGRUNT_PROVIDER_CACHE_DIR (deprecated: See migration guide)

The path to the Terragrunt provider cache directory. By default, terragrunt/providers folder in the user cache directory: $HOME/.cache on Unix systems, $HOME/Library/Caches on Darwin, %LocalAppData% on Windows. The file structure of the cache directory is identical to the OpenTofu/Terraform plugin_cache_dir directory. Make sure to read Provider Cache Server for context.

provider-cache-hostname

CLI Arg: --provider-cache-hostname
CLI Arg Alias: --terragrunt-provider-cache-hostname (deprecated: See migration guide)
Environment Variable: TG_PROVIDER_CACHE_HOSTNAME
Environment Variable Alias: TERRAGRUNT_PROVIDER_CACHE_HOSTNAME (deprecated: See migration guide)

The hostname of the Terragrunt Provider Cache server. By default, ‘localhost’. Make sure to read Provider Cache Server for context.

provider-cache-port

CLI Arg: --provider-cache-port
CLI Arg Alias: --terragrunt-provider-cache-port (deprecated: See migration guide)
Environment Variable: TG_PROVIDER_CACHE_PORT
Environment Variable Alias: TERRAGRUNT_PROVIDER_CACHE_PORT (deprecated: See migration guide)

The port of the Terragrunt Provider Cache server. By default, assigned automatically. Make sure to read Provider Cache Server for context.

provider-cache-token

CLI Arg: --provider-cache-token
CLI Arg Alias: --terragrunt-provider-cache-token (deprecated: See migration guide)
Environment Variable: TG_PROVIDER_CACHE_TOKEN
Environment Variable Alias: TERRAGRUNT_PROVIDER_CACHE_TOKEN (deprecated: See migration guide)

The Token for authentication on the Terragrunt Provider Cache server. By default, assigned automatically. Make sure to read Provider Cache Server for context.

provider-cache-registry-names

CLI Arg: --provider-cache-registry-names
CLI Arg Alias: --terragrunt-provider-cache-registry-names (deprecated: See migration guide)
Environment Variable: TG_PROVIDER_CACHE_REGISTRY_NAMES
Environment Variable Alias: TERRAGRUNT_PROVIDER_CACHE_REGISTRY_NAMES (deprecated: See migration guide)

The list of remote registries to cached by Terragrunt Provider Cache server. By default, ‘registry.terraform.io’, ‘registry.opentofu.org’. Make sure to read Provider Cache Server for context.

out-dir

CLI Arg: --out-dir
CLI Arg Alias: --terragrunt-out-dir (deprecated: See migration guide)
Environment Variable: TG_OUT_DIR
Environment Variable Alias: TERRAGRUNT_OUT_DIR (deprecated: See migration guide)

Specify the plan output directory for the *-all commands. Useful to save plans between runs in a single place.

json-out-dir

CLI Arg: --json-out-dir
CLI Arg Alias: --terragrunt-json-out-dir (deprecated: See migration guide)
Environment Variable: TG_JSON_OUT_DIR
Environment Variable Alias: TERRAGRUNT_JSON_OUT_DIR (deprecated: See migration guide)

Specify the output directory for the *-all commands to store plans in JSON format. Useful to read plans programmatically.

tf-forward-stdout

CLI Arg: --tf-forward-stdout
CLI Arg Alias: --terragrunt-forward-tf-stdout (deprecated: See migration guide)
Environment Variable: TG_TF_FORWARD_STDOUT
Environment Variable Alias: TERRAGRUNT_FORWARD_TF_STDOUT (deprecated: See migration guide)

If specified, the output of Terraform/OpenTofu commands will be printed as is. By default, all logs, except when using the output command or -json flags, are integrated into the Terragrunt log.

The example of what the log looks like without the --tf-forward-stdout flag specified:

14:19:25.081 INFO   [app] Running command: tofu plan -input=false
14:19:25.174 STDOUT [app] tofu: OpenTofu used the selected providers to generate the following execution
14:19:25.174 STDOUT [app] tofu: plan. Resource actions are indicated with the following symbols:
14:19:25.174 STDOUT [app] tofu:   + create
14:19:25.174 STDOUT [app] tofu: OpenTofu will perform the following actions:

The example of what the log looks like with the --tf-forward-stdout flag specified:

14:19:25.081 INFO   [app] Running command: tofu plan -input=false

OpenTofu used the selected providers to generate the following execution
plan. Resource actions are indicated with the following symbols:
  + create

OpenTofu will perform the following actions:

no-destroy-dependencies-check

CLI Arg: --no-destroy-dependencies-check
CLI Arg Alias: --terragrunt-no-destroy-dependencies-check (deprecated: See migration guide)
Environment Variable: TG_NO_DESTROY_DEPENDENCIES_CHECK
Environment Variable Alias: TERRAGRUNT_NO_DESTROY_DEPENDENCIES_CHECK (deprecated: See migration guide)

If specified, Terragrunt will not check dependent units when running the destroy command.

By default, Terragrunt checks dependent units when running destroy command to provide a warning that other units may be not work correctly if their dependency is destroyed.

feature

CLI Arg: --feature
Environment Variable: TG_FEATURE
Environment Variable Alias: TERRAGRUNT_FEATURE (deprecated: See migration guide)

Feature flags in Terragrunt allow users to dynamically control configuration behavior through CLI arguments or environment variables.

These flags enable a more flexible and controlled deployment process, particularly in monorepo contexts with interdependent infrastructure units.

Example HCL flags definition:

feature "string_feature_flag" {
  default = "test"
}

feature "int_feature_flag" {
  default = 777
}

feature "bool_feature_flag" {
  default = false
}

terraform {
  before_hook "conditional_command" {
    commands = ["apply", "plan", "destroy"]
    execute  = feature.bool_feature_flag.value ? ["sh", "-c", "echo running conditional bool_feature_flag"] : [ "sh", "-c", "exit", "0" ]
  }
}

inputs = {
  string_feature_flag = feature.string_feature_flag.value
  int_feature_flag = feature.int_feature_flag.value
}

Setting a feature flag through the CLI:

terragrunt --feature int_feature_flag=123 --feature bool_feature_flag=true --feature string_feature_flag=app1 apply

Setting feature flags through environment variables:

export TERRAGRUNT_FEATURE=int_feature_flag=123,bool_feature_flag=true,string_feature_flag=app1
terragrunt apply

experiment

CLI Arg: --experiment
Environment Variable: TG_EXPERIMENT

Enable experimental features in Terragrunt before they’re stable.

For more information, see the Experiments documentation.

experiment-mode

CLI Arg: --experiment-mode
Environment Variable: TG_EXPERIMENT_MODE

Enable all experimental features in Terragrunt before they’re stable.

For more information, see the Experiments documentation.

strict-control

CLI Arg: --strict-control
Environment Variable: TERRAGRUNT_STRICT_CONTROL

Enable strict controls that opt-in future breaking changes in Terragrunt.

For more information, see the Strict Mode documentation.

strict-mode

CLI Arg: --strict-mode
Environment Variable: TERRAGRUNT_STRICT_MODE

Enable all strict controls that opt-in future breaking changes in Terragrunt.

For more information, see the Strict Mode documentation.

in-download-dir

CLI Arg: --in-download-dir
Environment Variable: TG_IN_DOWNLOAD_DIR
Commands:

• exec

Execute the provided command in the download directory.

Deprecated

Deprecated Commands

The following are deprecated commands that are no longer recommended for use. They are still available for backwards compatibility, but will be removed in a future release.

• Deprecated Commands
  • plan-all (DEPRECATED: use run –all plan)
  • apply-all (DEPRECATED: use run –all apply)
  • output-all (DEPRECATED: use run –all output)
  • destroy-all (DEPRECATED: use run –all destroy)
  • validate-all (DEPRECATED: use run –all validate)
  • run-all (DEPRECATED: use run –all)
  • graph (DEPRECATED: use run –graph)
  • graph-dependencies (DEPRECATED: use dag graph)
  • hclfmt (DEPRECATED: use run –hclfmt)
  • hclvalidate (DEPRECATED: use run –hclvalidate)
  • output-module-groups (DEPRECATED: use run –output-module-groups)
  • render-json (DEPRECATED: use run –render-json)
  • terragrunt-info (DEPRECATED: use run –terragrunt-info)
  • validate-inputs (DEPRECATED: use run –validate-inputs)

plan-all

DEPRECATED: Use run --all plan instead.

Display the plans of a stack by running terragrunt plan in each subfolder. Make sure to read Execute OpenTofu/Terraform commands on multiple modules at once for context.

Example:

terragrunt run --all plan

This will recursively search the current working directory for any folders that contain Terragrunt modules and run plan in each one, concurrently, while respecting ordering defined via dependency and dependencies blocks.

[WARNING] run --all plan is currently broken for certain use cases. If you have a stack of Terragrunt modules with dependencies between them—either via dependency blocks or terraform_remote_state data sources—and you’ve never deployed them, then run --all plan will fail as it will not be possible to resolve the dependency blocks or terraform_remote_state data sources! Please see here for more information.

apply-all

DEPRECATED: Use run --all apply instead.

Apply a stack by running terragrunt apply in each subfolder. Make sure to read Execute OpenTofu/Terraform commands on multiple modules at once for context.

Example:

terragrunt apply-all

This will recursively search the current working directory for any folders that contain Terragrunt modules and run apply in each one, concurrently, while respecting ordering defined via dependency and dependencies blocks.

[NOTE] Using apply-all silently adds the -auto-approve flag to the command line arguments passed to OpenTofu/Terraform due to issues with shared stdin making individual approvals impossible. Please see here for more information

output-all

DEPRECATED: Use run --all output instead.

Display the outputs of a stack by running terragrunt output in each subfolder. Make sure to read Execute OpenTofu/Terraform commands on multiple modules at once for context.

Example:

terragrunt output-all

This will recursively search the current working directory for any folders that contain Terragrunt modules and run output in each one, concurrently, while respecting ordering defined via dependency and dependencies blocks.

[WARNING] output-all is currently broken for certain use cases. If you have a stack of Terragrunt modules with dependencies between them—either via dependency blocks or terraform_remote_state data sources—and you’ve never deployed them, then output-all will fail as it will not be possible to resolve the dependency blocks or terraform_remote_state data sources! Please see here for more information.

destroy-all

DEPRECATED: Use run --all destroy instead.

Destroy a stack by running terragrunt destroy in each subfolder. Make sure to read Execute OpenTofu/Terraform commands on multiple modules at once for context.

Example:

terragrunt destroy-all

This will recursively search the current working directory for any folders that contain Terragrunt modules and run destroy in each one, concurrently, while respecting ordering defined via dependency and dependencies blocks.

[NOTE] Using destroy-all silently adds the -auto-approve flag to the command line arguments passed to OpenTofu/Terraform due to issues with shared stdin making individual approvals impossible. Please see here for more information

validate-all

DEPRECATED: Use run --all validate instead.

Validate stack by running terragrunt validate in each subfolder. Make sure to read Execute OpenTofu/Terraform commands on multiple modules at once for context.

Example:

terragrunt validate-all

This will recursively search the current working directory for any folders that contain Terragrunt modules and run validate in each one, concurrently, while respecting ordering defined via dependency and dependencies blocks.

run-all

DEPRECATED: Use run --all instead.

Runs the provided OpenTofu/Terraform command against a stack. The command will recursively find terragrunt units in the current directory tree and run the OpenTofu/Terraform command in dependency order (unless the command is destroy, in which case the command is run in reverse dependency order).

Make sure to read about the stacks feature for context.

Example:

terragrunt run --all apply  # New syntax

This will recursively search the current working directory for any folders that contain Terragrunt units and run apply in each one, concurrently, while respecting ordering defined via dependency and dependencies blocks.

[WARNING] Do not set TF_PLUGIN_CACHE_DIR when using run-all

Instead take advantage of the built-in Provider Cache Server that mitigates some of the limitations of using the OpenTofu/Terraform Provider Plugin Cache directly.

We are working with the OpenTofu team to improve this behavior so that you don’t have to worry about this in the future.

[NOTE] Use run-all with care if you have unapplied dependencies.

If you have a stack of Terragrunt units with dependencies between them via dependency blocks and you’ve never deployed them, then commands like run-all plan will fail, as it won’t be possible to resolve outputs of dependency blocks without applying them first.

The solution for this is to take advantage of mock outputs in dependency blocks.

[NOTE] Using run-all with apply or destroy silently adds the -auto-approve flag to the command line arguments passed to OpenTofu/Terraform due to issues with shared stdin making individual approvals impossible.

[NOTE] Using the OpenTofu/Terraform -detailed-exitcode flag with the run-all command results in an aggregate exit code being returned, rather than the exit code of any particular unit.

The algorithm for determining the aggregate exit code is as follows:

• If any unit throws a 1, Terragrunt will throw a 1.
• If any unit throws a 2, but nothing throws a 1, Terragrunt will throw a 2.
• If nothing throws a non-zero, Terragrunt will throw a 0.

graph

DEPRECATED: Use run --graph instead.

Run the provided OpenTofu/Terraform command against the graph of dependencies for the unit in the current working directory. The graph consists of all units that depend on the unit in the current working directory via a dependency or dependencies blocks, plus all the units that depend on those units, and all the units that depend on those units, and so on, recursively up the tree, up to the Git repository root, or the path specified via the optional --graph-root argument.

The Command will be executed following the order of dependencies: so it’ll run on the unit in the current working directory first, then on units that depend on it directly, then on the units that depend on those units, and so on. Note that if the command is destroy, it will run in the opposite order (the final dependents, then their dependencies, etc. up to the unit you ran the command in).

Example: Given the following dependencies:

Running terragrunt graph apply in eks module will lead to the following execution order:

Group 1
- Module project/eks

Group 2
- Module project/services/eks-service-1
- Module project/services/eks-service-2

Group 3
- Module project/services/eks-service-2-v2
- Module project/services/eks-service-3
- Module project/services/eks-service-5

Group 4
- Module project/services/eks-service-3-v2
- Module project/services/eks-service-4

Group 5
- Module project/services/eks-service-3-v3

Notes:

• lambda units aren’t included in the graph, because they are not dependent on eks unit.
• execution is from bottom up based on dependencies

Running terragrunt graph destroy in eks unit will lead to the following execution order:

Group 1
- Module project/services/eks-service-2-v2
- Module project/services/eks-service-3-v3
- Module project/services/eks-service-4
- Module project/services/eks-service-5

Group 2
- Module project/services/eks-service-3-v2

Group 3
- Module project/services/eks-service-3

Group 4
- Module project/services/eks-service-1
- Module project/services/eks-service-2

Group 5
- Module project/eks

Notes:

• execution is in reverse order, first are destroyed “top” units and in the end eks
• lambda units aren’t affected at all

Running terragrunt graph apply in services/eks-service-3:

Group 1
- Module project/services/eks-service-3

Group 2
- Module project/services/eks-service-3-v2
- Module project/services/eks-service-4

Group 3
- Module project/services/eks-service-3-v3

Notes:

• in execution are included only services dependent from eks-service-3

Running terragrunt graph destroy in services/eks-service-3:

Group 1
- Module project/services/eks-service-3-v3
- Module project/services/eks-service-4

Group 2
- Module project/services/eks-service-3-v2

Group 3
- Module project/services/eks-service-3

Notes:

• destroy will be executed only on subset of services dependent from eks-service-3

graph-dependencies

DEPRECATED: Use dag graph instead.

Prints the Terragrunt dependency graph, in DOT format, to stdout. You can generate charts from DOT format using tools such as GraphViz.

Example:

terragrunt graph-dependencies

This will recursively search the current working directory for any folders that contain Terragrunt modules and build the dependency graph based on dependency and dependencies blocks. This may produce output such as:

digraph {
  "mgmt/bastion-host" ;
  "mgmt/bastion-host" -> "mgmt/vpc";
  "mgmt/bastion-host" -> "mgmt/kms-master-key";
  "mgmt/kms-master-key" ;
  "mgmt/vpc" ;
  "stage/backend-app" ;
  "stage/backend-app" -> "stage/vpc";
  "stage/backend-app" -> "mgmt/bastion-host";
  "stage/backend-app" -> "stage/mysql";
  "stage/backend-app" -> "stage/search-app";
  "stage/frontend-app" ;
  "stage/frontend-app" -> "stage/vpc";
  "stage/frontend-app" -> "mgmt/bastion-host";
  "stage/frontend-app" -> "stage/backend-app";
  "stage/mysql" ;
  "stage/mysql" -> "stage/vpc";
  "stage/redis" ;
  "stage/redis" -> "stage/vpc";
  "stage/search-app" ;
  "stage/search-app" -> "stage/vpc";
  "stage/search-app" -> "stage/redis";
  "stage/vpc" ;
  "stage/vpc" -> "mgmt/vpc";
}

hclfmt

DEPRECATED: Use hcl format instead.

Recursively find hcl files and rewrite them into a canonical format.

Example:

terragrunt hclfmt

This will recursively search the current working directory for any folders that contain Terragrunt configuration files and run the equivalent of tofu fmt/terraform fmt on them.

hclvalidate

DEPRECATED: Use hcl validate instead.

Find all hcl files from the configuration stack and validate them.

Example:

terragrunt hclvalidate

This will search all hcl files from the configuration stack in the current working directory and run the equivalent of tofu validate/terraform validate on them.

For convenience in programmatically parsing these findings, you can also pass the --json flag to output the results in JSON format.

Example:

terragrunt hclvalidate --json

In addition, you can pass the --show-config-path flag to only output paths of the invalid config files, delimited by newlines. This can be especially useful when combined with the queue-excludes-file flag.

Example:

terragrunt hclvalidate --show-config-path

output-module-groups

DEPRECATED: Use find --dag --json or list --dag --tree instead.

Output groups of modules ordered for apply (or destroy) as a list of list in JSON.

Example:

terragrunt output-module-groups <sub-command>

Optional sub-commands:

• apply (default)
• destroy

This will recursively search the current working directory for any folders that contain Terragrunt modules and build the dependency graph based on dependency and dependencies blocks and output the graph as a JSON list of list (unless the sub-command is destroy, in which case the command will output the reverse dependency order).

This can be be useful in several scenarios, such as in CICD, when determining apply order or searching for all files to apply with CLI options such as --units-that-include

This may produce output such as:

{
  "Group 1": ["stage/frontend-app"],
  "Group 2": ["stage/backend-app"],
  "Group 3": ["mgmt/bastion-host", "stage/search-app"],
  "Group 4": ["mgmt/kms-master-key", "stage/mysql", "stage/redis"],
  "Group 5": ["stage/vpc"],
  "Group 6": ["mgmt/vpc"]
}

render-json

DEPRECATED: Use render --json -w instead.

Render out the final interpreted terragrunt.hcl file (that is, with all the includes merged, dependencies resolved/interpolated, function calls executed, etc) as json.

Example:

The following terragrunt.hcl:

locals {
  aws_region = "us-east-1"
}

inputs = {
  aws_region = local.aws_region
}

Renders to the following terragrunt_rendered.json:

{
  "locals": { "aws_region": "us-east-1" },
  "inputs": { "aws_region": "us-east-1" }
  // NOTE: other attributes are omitted for brevity
}

You can use the CLI option --out to configure where terragrunt renders out the json representation.

To generate json with metadata can be specified argument --with-metadata which will add metadata to the json output.

Example:

{
  "inputs": {
    "aws_region": {
      "metadata": {
        "found_in_file": "/example/terragrunt.hcl"
      },
      "value": "us-east-1"
    }
  },
  "locals": {
    "aws_region": {
      "metadata": {
        "found_in_file": "/example/terragrunt.hcl"
      },
      "value": "us-east-1"
    }
  }
  // NOTE: other attributes are omitted for brevity
}

terragrunt-info

DEPRECATED: Use info print instead.

Emits limited terragrunt state on stdout in a JSON format and exits.

Example:

terragrunt terragrunt-info

Might produce output such as:

{
  "ConfigPath": "/example/path/terragrunt.hcl",
  "DownloadDir": "/example/path/.terragrunt-cache",
  "IamRole": "",
  "TerraformBinary": "terraform",
  "TerraformCommand": "terragrunt-info",
  "WorkingDir": "/example/path"
}

validate-inputs

DEPRECATED: Use hcl validate --inputs or hcl validate --inputs --strict instead.

Emits information about the input variables that are configured with the given terragrunt configuration. Specifically, this command will print out unused inputs (inputs that are not defined as an OpenTofu/Terraform variable in the corresponding module) and undefined required inputs (required OpenTofu/Terraform variables that are not currently being passed in).

Example:

> terragrunt validate-inputs
The following inputs passed in by terragrunt are unused:

    - foo
    - bar


The following required inputs are missing:

    - baz

Note that this only checks for variables passed in in the following ways:

• Configured inputs attribute.

• var files defined on terraform.extra_arguments blocks using required_var_files and optional_var_files.

• -var-file and -var CLI arguments defined on terraform.extra_arguments using arguments.

• -var-file and -var CLI arguments passed to terragrunt.

• Automatically loaded var files (terraform.tfvars, terraform.tfvars.json, *.auto.tfvars, *.auto.tfvars.json)

• TF_VAR environment variables defined on terraform.extra_arguments blocks.

• TF_VAR environment variables defined in the environment.

Be aware that other ways to pass variables to tofu/terraform are not checked by this command.

Additionally, there are two modes in which the validate-inputs command can be run: relaxed (default) and strict.

If you run the validate-inputs command without flags, relaxed mode will be enabled by default. In relaxed mode, any unused variables that are passed, but not used by the underlying OpenTofu/Terraform configuration, will generate a warning, but not an error. Missing required variables will always return an error, whether validate-inputs is running in relaxed or strict mode.

To enable strict mode, you can pass the --strict-validate flag like so:

> terragrunt validate-inputs --strict-validate

When running in strict mode, validate-inputs will return an error if there are unused inputs.

This command will exit with an error if terragrunt detects any unused inputs or undefined required inputs.

Deprecated Flags

The following are deprecated flags that are no longer recommended for use. They are still available for backwards compatibility, but will be removed in a future release.

• Deprecated Flags
  • include-module-prefix
  • json-log
  • tf-logs-to-json (DEPRECATED: use log-format)
  • disable-log-formatting (DEPRECATED: use log-format)

terragrunt-include-module-prefix

DEPRECATED: Since this behavior has become the default, this flag has been removed. In order to get raw Terraform/OpenTofu output, use tf-forward-stdout.

CLI Arg: --terragrunt-include-module-prefix
Environment Variable: TERRAGRUNT_INCLUDE_MODULE_PREFIX (set to true)

When this flag is set output from OpenTofu/Terraform sub-commands is prefixed with module path.

terragrunt-json-log

DEPRECATED: Use log-format.

CLI Arg: --terragrunt-json-log
Environment Variable: TERRAGRUNT_JSON_LOG (set to true)

When this flag is set, Terragrunt will output its logs in JSON format.

terragrunt-tf-logs-to-json

DEPRECATED: Use log-format.

OpenTofu/Terraform stdout and stderr are wrapped in JSON by default when using the --log-format json flag if the --terragrunt-tf-forward-stdout flag is not specified.

In other words, the behavior when using the deprecated --json-log --terragrunt-tf-logs-to-json flags is now equivalent to --log-format json and the previous behavior with the --terragrunt-json-log is now equivalent to --log-format json --terragrunt-tf-forward-stdout.

CLI Arg: --tf-logs-to-json
Environment Variable: TERRAGRUNT_TF_JSON_LOG (set to true)

When this flag is set, Terragrunt will wrap OpenTofu/Terraform stdout and stderr in JSON log messages. Works only with --json-log flag.

terragrunt-disable-log-formatting

DEPRECATED: Use log-format.

CLI Arg: --terragrunt-disable-log-formatting
Environment Variable: TERRAGRUNT_DISABLE_LOG_FORMATTING
CLI Arg Alias: (deprecated: [See migration guide](/docs/migrate/cli-redesign/))<br/> **Environment Variable Alias**: (deprecated: See migration guide)

If specified, logs will be displayed in key/value format. By default, logs are formatted in a human readable format.

The example of what the log looks like without the --terragrunt-disable-log-formatting flag specified:

14:19:25.081 INFO   [app] Running command: tofu plan -input=false
14:19:25.174 STDOUT [app] tofu: OpenTofu used the selected providers to generate the following execution
14:19:25.174 STDOUT [app] tofu: plan. Resource actions are indicated with the following symbols:
14:19:25.174 STDOUT [app] tofu:   + create
14:19:25.174 STDOUT [app] tofu: OpenTofu will perform the following actions:

The example of what the log looks like with the --tf-forward-stdout flag specified:

time=2024-08-23T11:47:18+03:00 level=info prefix=app msg=Running command: tofu plan -input=false
time=2024-08-23T11:47:18+03:00 level=stdout prefix=app binary=tofu msg=OpenTofu used the selected providers to generate the following execution
time=2024-08-23T11:47:18+03:00 level=stdout prefix=app binary=tofu msg=plan. Resource actions are indicated with the following symbols:
time=2024-08-23T11:47:18+03:00 level=stdout prefix=app binary=tofu msg=  + create
time=2024-08-23T11:47:18+03:00 level=stdout prefix=app binary=tofu msg=OpenTofu will perform the following actions: