Skip to content
Terragrunt
👷 The Terragrunt website redesign is Work In Progress! 👷
For a list of outstanding TODOs see this.
To give feedback, click here.

catalog

Usage

Launch a Terminal User Interface (TUI) to browse and use OpenTofu/Terraform modules.

Examples

Start up a catalog using the configurations discovered in a parent Terragrunt configuration.

Terminal window
terragrunt catalog

Explicitly indicate the name of the root configuration being discovered.

Terminal window
terragrunt catalog --root-file-name root.hcl
Terminal window
terragrunt catalog [repo-url] [options]

For more information on how the catalog works, see the dedicated catalog documentation.

Flags

--no-include-root

Do not include the root configuration file in any generated terragrunt.hcl file during scaffolding.

When enabled, Terragrunt will not automatically include the root configuration file in generated terragrunt.hcl files during scaffolding operations in the catalog.

This is useful when you want more control over which configurations are included in newly scaffolded modules.

Examples:

Terminal window
terragrunt catalog --no-include-root
Type: bool

Environment Variables:

  • TG_NO_INCLUDE_ROOT

--root-file-name

The name of the root configuration file to include in any generated terragrunt.hcl during scaffolding.

Specifies the name of the root configuration file that should be:

  • Included in generated terragrunt.hcl files during scaffolding
  • Used when searching for Catalog URLs

This is particularly useful when your root configuration uses a different naming convention than the default.

Example:

Terminal window
terragrunt catalog --root-file-name root.hcl
Type: string

Environment Variables:

  • TG_ROOT_FILE_NAME