Documentation

Quick start

Learn how to start with Terragrunt.

Install

Learn how to install Terragrunt on Windows, Mac OS, Linux, FreeBSD and manually from source.

Terminology

Quickly understand commonly use terms in Terragrunt.

Terraform and OpenTofu Version Compatibility Table

Learn which Terraform and OpenTofu versions are compatible with which versions of Terragrunt.

Configuration

Learn how to configure Terragrunt.

Add to OpenTofu Project

Add Terragrunt to an existing OpenTofu/Terraform project.

Keep your OpenTofu/Terraform code DRY

Learn how to achieve DRY OpenTofu/Terraform code and immutable infrastructure.

Keep your remote state configuration DRY

Learn how to create and manage remote state configuration.

Keep your Terragrunt Architecture DRY

Learn how to use multiple terragrunt configurations to DRY up your architecture.

Catalog

Learn how to use catalog function in Terragrunt.

Scaffold

Learn how to scaffold Terragrunt projects.

Keep your CLI flags DRY

Learn how to keep CLI flags DRY with "extra_arguments" block in your "terragrunt.hcl".

Execute OpenTofu/Terraform commands on multiple units at once

Learn how to avoid tedious tasks of running commands on each unit separately.

Work with multiple AWS accounts

Learn how the Terragrunt may help you to work with multiple AWS accounts.

Inputs

Learn how to use inputs.

Locals

Learn how to use locals.

Before, After, and Error Hooks

Learn how to execute custom code before or after running OpenTofu/Terraform, or when errors occur.

Auto-init

Auto-Init is a feature of Terragrunt that makes it so that terragrunt init does not need to be called explicitly before other terragrunt commands.

Auto-retry

Auto-Retry is a feature of terragrunt that will automatically address situations where an OpenTofu/Terraform command needs to be re-run.

Caching

Learn more about caching in Terragrunt.

AWS Auth

Learn how the Terragrunt works with AWS Credentials and AWS IAM policies.

Debugging

Learn how to debug issues with terragrunt and tofu/terraform.

Lock File Handling

Learn how to Terragrunt handles the OpenTofu/Terraform lock file

Custom Log Format

Learn how to use terragrunt provider cache.

Provider Caching

Learn how to use terragrunt provider cache.

IaC Engines

Contributing

Terragrunt is an open source project, and contributions from the community are very welcome!

Support

Need help?

License

This code is released under the MIT License. Read more here.

CLI options

Learn about all CLI arguments and options you can use with Terragrunt.

Built-in functions

Terragrunt allows you to use built-in functions anywhere in `terragrunt.hcl`, just like OpenTofu/Terraform.

Configuration Blocks and Attributes

Learn about all the blocks and attributes supported in the terragrunt configuration file.

Strict Mode

Opt-in to strict mode to avoid deprecated features and ensure your code is future-proof.

RFC Template for Contributors

This is a template you can use for proposing new major features to Terragrunt.

for_each to call terraform module multiple times

for_each - looping variables to call module multiple times.

Custom state configuration

Allow further customization of Terraform Lock table for S3 Remote State.

Imports

Define new mechanisms for importing terragrunt config.

Terragrunt 0.19 migration guide

Migration guide to upgrade to terragrunt 0.19.x