cli

package
v0.99.0 Latest Latest
Warning

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

 Go to latest Published: Jan 26, 2026 License: MIT Imports: 19 Imported by: 0

Documentation

Overview

Package cli configures the Terragrunt CLI app and its commands.

Index

Constants

View Source 
const AppHelpTemplate = `` /* 1084-byte string literal not displayed */

AppHelpTemplate is the main CLI help template.

View Source 
const (
	AppName = "terragrunt"
)
View Source 
const AppVersionTemplate = `{{ .App.Name }} version {{ .App.Version }}
`
View Source 
const CommandHelpTemplate = `` /* 1188-byte string literal not displayed */

CommandHelpTemplate is the command CLI help template.

Variables

This section is empty.

Functions

func ExitErrHandler added in v0.98.0 

func ExitErrHandler(_ *clihelper.Context, err error) error

ExitErrHandler is an empty function that overrides the default behavior.

func OSExiter added in v0.98.0 

func OSExiter(exitCode int)

OSExiter is an empty function that overrides the default behavior.

Types

type App 

type App struct {
	*clihelper.App
	// contains filtered or unexported fields
}

func NewApp 

func NewApp(l log.Logger, opts *options.TerragruntOptions) *App

NewApp creates the Terragrunt CLI App.

func (*App) Run 

func (app *App) Run(args []string) error

func (*App) RunContext 

func (app *App) RunContext(ctx context.Context, args []string) error

Source Files

View all Source files

Directories

Path Synopsis
Package commands represents CLI commands.
 Package commands represents CLI commands.
aws-provider-patch
Package awsproviderpatch provides the `aws-provider-patch` command.
 Package awsproviderpatch provides the `aws-provider-patch` command.
backend
Package backend provides commands for interacting with remote backends.
 Package backend provides commands for interacting with remote backends.
backend/bootstrap
Package bootstrap provides the ability to initialize remote state backend.
 Package bootstrap provides the ability to initialize remote state backend.
backend/delete
Package delete provides the ability to remove remote state files/buckets.
 Package delete provides the ability to remove remote state files/buckets.
backend/migrate
Package migrate provides the ability to bootstrap remote state backend.
 Package migrate provides the ability to bootstrap remote state backend.
catalog
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.
catalog/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.
catalog/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.
catalog/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.
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).
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.
exec
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.
find
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.
hcl/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.
hcl/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.
help
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.
info
Package info represents list of info commands that display various Terragrunt settings.
 Package info represents list of info commands that display various Terragrunt settings.
info/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.
info/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.
list
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.
render
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.
run
Package run contains the CLI command definition for interacting with OpenTofu/Terraform.
 Package run contains the CLI command definition for interacting with OpenTofu/Terraform.
scaffold
Package scaffold provides the command to scaffold a new Terragrunt module.
 Package scaffold provides the command to scaffold a new Terragrunt module.
stack
Package stack provides the command to stack.
 Package stack provides the command to stack.
version
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.
Package flags provides tools that are used by all commands to create deprecation flags with strict controls.
 Package flags provides tools that are used by all commands to create deprecation flags with strict controls.
global
Package global provides CLI global flags.
 Package global provides CLI global flags.
shared
Package shared provides flags that are shared by multiple commands.
 Package shared provides flags that are shared by multiple commands.

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.