commands

package
v0.97.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 9, 2026 License: MIT Imports: 35 Imported by: 0

Documentation

Overview

Package commands represents CLI commands.

Index

Constants

View Source 
const (
	// MainCommandsCategoryName represents primary Terragrunt operations like run, exec.
	MainCommandsCategoryName = "Main commands"
	// CatalogCommandsCategoryName represents commands for managing Terragrunt catalogs.
	CatalogCommandsCategoryName = "Catalog commands"
	// DiscoveryCommandsCategoryName represents commands for discovering Terragrunt configurations.
	DiscoveryCommandsCategoryName = "Discovery commands"
	// ConfigurationCommandsCategoryName represents commands for managing Terragrunt configurations.
	ConfigurationCommandsCategoryName = "Configuration commands"
	// ShortcutsCommandsCategoryName represents OpenTofu-specific shortcut commands.
	ShortcutsCommandsCategoryName = "OpenTofu shortcuts"
)

Command category names.

Variables

This section is empty.

Functions

func New added in v0.73.2 

func New(l log.Logger, opts *options.TerragruntOptions) cli.Commands

New returns the set of Terragrunt commands, grouped into categories. Categories are ordered in increments of 10 for easy insertion of new categories.

func NewShortcutsCommands added in v0.73.0 

func NewShortcutsCommands(l log.Logger, opts *options.TerragruntOptions) cli.Commands

func WrapWithTelemetry added in v0.78.0 

func WrapWithTelemetry(l log.Logger, opts *options.TerragruntOptions) func(ctx context.Context, cliCtx *cli.Context, action cli.ActionFunc) error

WrapWithTelemetry wraps CLI command execution with setting of telemetry context and labels, if telemetry is disabled, just runAction the command.

Types

This section is empty.

Source Files

View all Source files

Directories

Path Synopsis
Package awsproviderpatch provides the `aws-provider-patch` command.
 Package awsproviderpatch provides the `aws-provider-patch` command.
Package backend provides commands for interacting with remote backends.
 Package backend provides commands for interacting with remote backends.
bootstrap
Package bootstrap provides the ability to initialize remote state backend.
 Package bootstrap provides the ability to initialize remote state backend.
delete
Package delete provides the ability to remove remote state files/buckets.
 Package delete provides the ability to remove remote state files/buckets.
migrate
Package migrate provides the ability to bootstrap remote state backend.
 Package migrate provides the ability to bootstrap remote state backend.
Package catalog provides the ability to interact with a catalog of OpenTofu/Terraform modules via the `terragrunt catalog` command.
 Package catalog provides the ability to interact with a catalog of OpenTofu/Terraform modules via the `terragrunt catalog` command.
tui
Package tui provides a text-based user interface for the Terragrunt catalog command.
 Package tui provides a text-based user interface for the Terragrunt catalog command.
tui/command
Package command provides the implementation of the terragrunt scaffold command This command is used to scaffold a new Terragrunt unit in the current directory.
 Package command provides the implementation of the terragrunt scaffold command This command is used to scaffold a new Terragrunt unit in the current directory.
tui/components/buttonbar
Package buttonbar provides a bubbletea component that displays an inline list of buttons.
 Package buttonbar provides a bubbletea component that displays an inline list of buttons.
Package common provides common code that are used by many commands.
 Package common provides common code that are used by many commands.
graph
Package graph provides the `graph` feature for Terragrunt.
 Package graph provides the `graph` feature for Terragrunt.
runall
Package runall provides the feature that runs a terraform command against a 'stack' by running the specified command in each subfolder.
 Package runall provides the feature that runs a terraform command against a 'stack' by running the specified command in each subfolder.
dag
Package dag implements the dag command to interact with the Directed Acyclic Graph (DAG).
 Package dag implements the dag command to interact with the Directed Acyclic Graph (DAG).
graph
Package graph implements the terragrunt dag graph command which generates a visual representation of the Terragrunt dependency graph in DOT language format.
 Package graph implements the terragrunt dag graph command which generates a visual representation of the Terragrunt dependency graph in DOT language format.
Package exec provides the ability to execute a command using Terragrunt, via the `terragrunt exec -- command_name` command.
 Package exec provides the ability to execute a command using Terragrunt, via the `terragrunt exec -- command_name` command.
Package find provides the ability to find Terragrunt configurations in your codebase via the `terragrunt find` command.
 Package find provides the ability to find Terragrunt configurations in your codebase via the `terragrunt find` command.
hcl
Package hcl provides commands for formatting and validating HCL configurations.
 Package hcl provides commands for formatting and validating HCL configurations.
format
Package format recursively looks for hcl files in the directory tree starting at workingDir, and formats them based on the language style guides provided by Hashicorp.
 Package format recursively looks for hcl files in the directory tree starting at workingDir, and formats them based on the language style guides provided by Hashicorp.
validate
Package validate-inputs collects all the terraform variables defined in the target module, and the terragrunt inputs that are configured, and compare the two to determine if there are any unused inputs or undefined required inputs.
 Package validate-inputs collects all the terraform variables defined in the target module, and the terragrunt inputs that are configured, and compare the two to determine if there are any unused inputs or undefined required inputs.
Package help represents the help CLI command that works the same as the `--help` flag.
 Package help represents the help CLI command that works the same as the `--help` flag.
Package info represents list of info commands that display various Terragrunt settings.
 Package info represents list of info commands that display various Terragrunt settings.
print
Package print implements the 'terragrunt info print' command that outputs Terragrunt context information in a structured JSON format.
 Package print implements the 'terragrunt info print' command that outputs Terragrunt context information in a structured JSON format.
strict
Package strict represents CLI command that displays Terragrunt's strict control settings.
 Package strict represents CLI command that displays Terragrunt's strict control settings.
Package list provides the ability to list Terragrunt configurations in your codebase via the `terragrunt list` command.
 Package list provides the ability to list Terragrunt configurations in your codebase via the `terragrunt list` command.
Package render provides the command to render the final terragrunt config in various formats.
 Package render provides the command to render the final terragrunt config in various formats.
Package run contains the CLI command definition for interacting with OpenTofu/Terraform.
 Package run contains the CLI command definition for interacting with OpenTofu/Terraform.
Package scaffold provides the command to scaffold a new Terragrunt module.
 Package scaffold provides the command to scaffold a new Terragrunt module.
Package stack provides the command to stack.
 Package stack provides the command to stack.
Package version represents the version CLI command that works the same as the `--version` flag.
 Package version represents the version CLI command that works the same as the `--version` flag.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.