Documentation

Quick Start

Start using Terragrunt today!

Overview

Get a high level overview of the most important Terragrunt features.

Install

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

Terminology

Quickly understand commonly use terms in Terragrunt.

Configuration

Learn how to configure Terragrunt.

Units

Learn how Terragrunt units result in atomic deployments and immutable infrastructure.

Stacks

Lean how to work with multiple units at once in a stack.

Includes

Learn how to reuse partial Terragrunt configurations to DRY up your configurations.

State Backend

Learn how Terragrunt can create and manage remote state backends.

Catalog

Learn how to search and use your module catalog with Terragrunt.

Scaffold

Learn how to scaffold Terragrunt units.

Extra Arguments

Learn how to pass extra arguments to every OpenTofu/Terraform run.

AWS Authentication

Learn how the Terragrunt handles AWS authentication.

Before, After, and Error Hooks

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

Auto-init

Learn how Terragrunt makes it so that you don't have to explicitly call `init` when using it.

Feature Flags, Errors and Excludes

Learn how Terragrunt allows for runtime control using feature flags, error handling, and excludes.

Provider Cache Server

Learn how to use the Terragrunt provider cache server.

IaC Engines

Learn how to dynamically control OpenTofu/Terraform runs using 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.

Experiments

Opt-in to experimental features before they're stable.

Terraform and OpenTofu Version Compatibility Table

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

Terragrunt Cache

Learn what the `.terragrunt-cache` directory is and how to manage it.

Lock File Handling

Learn how to Terragrunt handles the OpenTofu/Terraform lock file

Logging

Learn how Terragrunt decides what to log, and when.

Log Formatting

Learn how customize Terragrunt logging.

Migrating from root `terragrunt.hcl`

Migration guide to replace root `terragrunt.hcl` file

Terragrunt 0.19 migration guide

Migration guide to upgrade to terragrunt 0.19.x

Debugging

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

OpenTelemetry