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.

terragrunt catalog

Explicitly indicate the name of the root configuration being discovered.

terragrunt catalog --root-file-name root.hcl

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:

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:

terragrunt catalog --root-file-name root.hcl

Type: string

Environment Variables:

• TG_ROOT_FILE_NAME

--no-shell

Disable shell commands when using boilerplate templates in the catalog.

When enabled, Terragrunt will disable shell commands when processing boilerplate templates during catalog operations.

This is useful for security reasons when you want to prevent templates from executing arbitrary shell commands on your system.

Caution

Do not use catalog/scaffold to scaffold untrusted templates. IaC configurations are inherently powerful, as they can run arbitrary code on your system, so make sure to only use trusted templates you have reviewed and approved.

Note

Note that you will otherwise be prompted to confirm the execution of each shell command unless you are running in non-interactive mode.

Examples:

terragrunt catalog --no-shell

Type: bool

Environment Variables:

• TG_NO_SHELL

--no-hooks

Disable hooks when using boilerplate templates in the catalog.

When enabled, Terragrunt will disable hooks when processing boilerplate templates during catalog operations.

This is useful for security reasons when you want to prevent templates from executing arbitrary hooks on your system.

Caution

Do not use catalog/scaffold to scaffold untrusted templates. IaC configurations are inherently powerful, as they can run arbitrary code on your system, so make sure to only use trusted templates you have reviewed and approved.

Note

Note that you will otherwise be prompted to confirm the execution of each hook unless you are running in non-interactive mode.

Examples:

terragrunt catalog --no-hooks

Type: bool

Environment Variables:

• TG_NO_HOOKS

--no-cas

Disable the CAS (Content Addressable Storage) feature.

When this flag is set, Terragrunt skips all CAS operations and clones sources directly.

Generation or runs error when update_source_with_cas = true is set on any unit, stack, or terraform block reachable from the current invocation, since relative sources rewritten by CAS cannot be resolved without it.

Type: bool

Environment Variables:

• TG_NO_CAS

--cas-clone-depth

When using CAS, pass this value to git clone --depth (default 1; -1 clones full history).

Experimental

This flag only has an effect when the cas experiment is enabled. Enable it with --experiment=cas or TG_EXPERIMENT=cas.

Controls the --depth value the CAS (Content Addressable Storage) uses when cloning a Git source. The default of 1 performs a shallow clone of the latest commit. Negative values clone the full history by omitting --depth entirely; zero is rejected because Git requires a positive depth.

When passing a negative value, use the --cas-clone-depth=-1 form so the leading dash isn’t parsed as a flag.

Type: integer

Default: 1

Environment Variables:

• TG_CAS_CLONE_DEPTH