Documentation ¶
Overview ¶
Package commands provides the implementation of the Terragrunt commands.
Index ¶
Constants ¶
View Source
const ( TerragruntDisableLogFormattingFlagName = "terragrunt-disable-log-formatting" TerragruntDisableLogFormattingEnvName = "TERRAGRUNT_DISABLE_LOG_FORMATTING" TerragruntJSONLogFlagName = "terragrunt-json-log" TerragruntJSONLogEnvName = "TERRAGRUNT_JSON_LOG" TerragruntConfigFlagName = "terragrunt-config" TerragruntConfigEnvName = "TERRAGRUNT_CONFIG" TerragruntTFPathFlagName = "terragrunt-tfpath" TerragruntTFPathEnvName = "TERRAGRUNT_TFPATH" TerragruntNoAutoInitFlagName = "terragrunt-no-auto-init" TerragruntNoAutoInitEnvName = "TERRAGRUNT_NO_AUTO_INIT" TerragruntNoAutoRetryFlagName = "terragrunt-no-auto-retry" TerragruntNoAutoRetryEnvName = "TERRAGRUNT_NO_AUTO_RETRY" TerragruntNoAutoApproveFlagName = "terragrunt-no-auto-approve" TerragruntNoAutoApproveEnvName = "TERRAGRUNT_NO_AUTO_APPROVE" TerragruntNonInteractiveFlagName = "terragrunt-non-interactive" TerragruntNonInteractiveEnvName = "TERRAGRUNT_NON_INTERACTIVE" TerragruntWorkingDirFlagName = "terragrunt-working-dir" TerragruntWorkingDirEnvName = "TERRAGRUNT_WORKING_DIR" TerragruntDownloadDirFlagName = "terragrunt-download-dir" TerragruntDownloadDirEnvName = "TERRAGRUNT_DOWNLOAD" TerragruntSourceFlagName = "terragrunt-source" TerragruntSourceEnvName = "TERRAGRUNT_SOURCE" TerragruntSourceMapFlagName = "terragrunt-source-map" TerragruntSourceMapEnvName = "TERRAGRUNT_SOURCE_MAP" TerragruntSourceUpdateFlagName = "terragrunt-source-update" TerragruntSourceUpdateEnvName = "TERRAGRUNT_SOURCE_UPDATE" TerragruntIAMRoleFlagName = "terragrunt-iam-role" TerragruntIAMRoleEnvName = "TERRAGRUNT_IAM_ROLE" TerragruntIAMAssumeRoleDurationFlagName = "terragrunt-iam-assume-role-duration" TerragruntIAMAssumeRoleDurationEnvName = "TERRAGRUNT_IAM_ASSUME_ROLE_DURATION" TerragruntIAMAssumeRoleSessionNameFlagName = "terragrunt-iam-assume-role-session-name" TerragruntIAMAssumeRoleSessionNameEnvName = "TERRAGRUNT_IAM_ASSUME_ROLE_SESSION_NAME" TerragruntIAMWebIdentityTokenFlagName = "terragrunt-iam-web-identity-token" TerragruntIAMWebIdentityTokenEnvName = "TERRAGRUNT_IAM_ASSUME_ROLE_WEB_IDENTITY_TOKEN" TerragruntIgnoreDependencyErrorsFlagName = "terragrunt-ignore-dependency-errors" TerragruntIgnoreDependencyErrorsEnvName = "TERRAGRUNT_IGNORE_DEPENDENCY_ERRORS" TerragruntIgnoreDependencyOrderFlagName = "terragrunt-ignore-dependency-order" TerragruntIgnoreDependencyOrderEnvName = "TERRAGRUNT_IGNORE_DEPENDENCY_ORDER" TerragruntIgnoreExternalDependenciesFlagName = "terragrunt-ignore-external-dependencies" TerragruntIgnoreExternalDependenciesEnvName = "TERRAGRUNT_IGNORE_EXTERNAL_DEPENDENCIES" TerragruntIncludeExternalDependenciesFlagName = "terragrunt-include-external-dependencies" TerragruntIncludeExternalDependenciesEnvName = "TERRAGRUNT_INCLUDE_EXTERNAL_DEPENDENCIES" TerragruntExcludesFileFlagName = "terragrunt-excludes-file" TerragruntExcludesFileEnvName = "TERRAGRUNT_EXCLUDES_FILE" TerragruntExcludeDirFlagName = "terragrunt-exclude-dir" TerragruntExcludeDirEnvName = "TERRAGRUNT_EXCLUDE_DIR" TerragruntIncludeDirFlagName = "terragrunt-include-dir" TerragruntIncludeDirEnvName = "TERRAGRUNT_INCLUDE_DIR" TerragruntStrictIncludeFlagName = "terragrunt-strict-include" TerragruntStrictIncludeEnvName = "TERRAGRUNT_STRICT_INCLUDE" TerragruntParallelismFlagName = "terragrunt-parallelism" TerragruntParallelismEnvName = "TERRAGRUNT_PARALLELISM" TerragruntDebugFlagName = "terragrunt-debug" TerragruntDebugEnvName = "TERRAGRUNT_DEBUG" TerragruntTfLogJSONFlagName = "terragrunt-tf-logs-to-json" TerragruntTfLogJSONEnvName = "TERRAGRUNT_TF_JSON_LOG" TerragruntModulesThatIncludeFlagName = "terragrunt-modules-that-include" TerragruntModulesThatIncludeEnvName = "TERRAGRUNT_MODULES_THAT_INCLUDE" TerragruntFetchDependencyOutputFromStateFlagName = "terragrunt-fetch-dependency-output-from-state" TerragruntFetchDependencyOutputFromStateEnvName = "TERRAGRUNT_FETCH_DEPENDENCY_OUTPUT_FROM_STATE" TerragruntUsePartialParseConfigCacheFlagName = "terragrunt-use-partial-parse-config-cache" TerragruntUsePartialParseConfigCacheEnvName = "TERRAGRUNT_USE_PARTIAL_PARSE_CONFIG_CACHE" TerragruntFailOnStateBucketCreationFlagName = "terragrunt-fail-on-state-bucket-creation" TerragruntFailOnStateBucketCreationEnvName = "TERRAGRUNT_FAIL_ON_STATE_BUCKET_CREATION" TerragruntDisableBucketUpdateFlagName = "terragrunt-disable-bucket-update" TerragruntDisableBucketUpdateEnvName = "TERRAGRUNT_DISABLE_BUCKET_UPDATE" TerragruntDisableCommandValidationFlagName = "terragrunt-disable-command-validation" TerragruntDisableCommandValidationEnvName = "TERRAGRUNT_DISABLE_COMMAND_VALIDATION" TerragruntAuthProviderCmdFlagName = "terragrunt-auth-provider-cmd" TerragruntAuthProviderCmdEnvName = "TERRAGRUNT_AUTH_PROVIDER_CMD" TerragruntOutDirFlagEnvName = "TERRAGRUNT_OUT_DIR" TerragruntOutDirFlagName = "terragrunt-out-dir" TerragruntJSONOutDirFlagEnvName = "TERRAGRUNT_JSON_OUT_DIR" TerragruntJSONOutDirFlagName = "terragrunt-json-out-dir" TerragruntNoDestroyDependenciesCheckFlagEnvName = "TERRAGRUNT_NO_DESTROY_DEPENDENCIES_CHECK" TerragruntNoDestroyDependenciesCheckFlagName = "terragrunt-no-destroy-dependencies-check" TerragruntLogLevelFlagName = "terragrunt-log-level" TerragruntLogLevelEnvName = "TERRAGRUNT_LOG_LEVEL" TerragruntLogDisableFlagName = "terragrunt-log-disable" TerragruntLogDisableEnvName = "TERRAGRUNT_LOG_DISABLE" TerragruntNoColorFlagName = "terragrunt-no-color" TerragruntNoColorEnvName = "TERRAGRUNT_NO_COLOR" TerragruntShowLogAbsPathsFlagName = "terragrunt-log-show-abs-paths" TerragruntShowLogAbsPathsEnvName = "TERRAGRUNT_LOG_SHOW_ABS_PATHS" TerragruntForwardTFStdoutFlagName = "terragrunt-forward-tf-stdout" TerragruntForwardTFStdoutEnvName = "TERRAGRUNT_FORWARD_TF_STDOUT" TerragruntStrictModeFlagName = "strict-mode" TerragruntStrictModeEnvName = "TERRAGRUNT_STRICT_MODE" TerragruntStrictControlFlagName = "strict-control" TerragruntStrictControlEnvName = "TERRAGRUNT_STRICT_CONTROL" TerragruntProviderCacheFlagName = "terragrunt-provider-cache" TerragruntProviderCacheEnvName = "TERRAGRUNT_PROVIDER_CACHE" TerragruntProviderCacheDirFlagName = "terragrunt-provider-cache-dir" TerragruntProviderCacheDirEnvName = "TERRAGRUNT_PROVIDER_CACHE_DIR" TerragruntProviderCacheHostnameFlagName = "terragrunt-provider-cache-hostname" TerragruntProviderCacheHostnameEnvName = "TERRAGRUNT_PROVIDER_CACHE_HOSTNAME" TerragruntProviderCachePortFlagName = "terragrunt-provider-cache-port" TerragruntProviderCachePortEnvName = "TERRAGRUNT_PROVIDER_CACHE_PORT" TerragruntProviderCacheTokenFlagName = "terragrunt-provider-cache-token" TerragruntProviderCacheTokenEnvName = "TERRAGRUNT_PROVIDER_CACHE_TOKEN" TerragruntProviderCacheRegistryNamesFlagName = "terragrunt-provider-cache-registry-names" TerragruntProviderCacheRegistryNamesEnvName = "TERRAGRUNT_PROVIDER_CACHE_REGISTRY_NAMES" TerragruntEngineEnableEnvName = "TG_EXPERIMENTAL_ENGINE" TerragruntEngineCachePathEnv = "TG_ENGINE_CACHE_PATH" TerragruntEngineSkipCheckEnv = "TG_ENGINE_SKIP_CHECK" TerragruntEngineLogLevelEnv = "TG_ENGINE_LOG_LEVEL" HelpFlagName = "help" VersionFlagName = "version" )
Variables ¶
This section is empty.
Functions ¶
func NewGlobalFlags ¶
func NewGlobalFlags(opts *options.TerragruntOptions) cli.Flags
NewGlobalFlags creates and returns global flags.
func NewHelpFlag ¶
func NewHelpFlag(opts *options.TerragruntOptions) cli.Flag
func NewHelpVersionFlags ¶ added in v0.53.4
func NewHelpVersionFlags(opts *options.TerragruntOptions) cli.Flags
func NewVersionFlag ¶
func NewVersionFlag(opts *options.TerragruntOptions) cli.Flag
Types ¶
This section is empty.
Directories ¶
Path | Synopsis |
---|---|
Package awsproviderpatch provides the `aws-provider-patch` command.
|
Package awsproviderpatch provides the `aws-provider-patch` command. |
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. |
module
Package module provides a struct to represent an OpenTofu/Terraform module.
|
Package module provides a struct to represent an OpenTofu/Terraform module. |
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 graph provides the `graph` command for Terragrunt.
|
Package graph provides the `graph` command for Terragrunt. |
Package graphdependencies provides the command to print the terragrunt dependency graph to stdout.
|
Package graphdependencies provides the command to print the terragrunt dependency graph to stdout. |
Package hclfmt provides the hclfmt command for formatting HCL files.
|
Package hclfmt provides the hclfmt command for formatting HCL files. |
Package hclvalidate provides the `hclvalidate` command for Terragrunt.
|
Package hclvalidate provides the `hclvalidate` command for Terragrunt. |
Package outputmodulegroups provides a command to output groups of modules ordered by command (apply or destroy) as a list of list in JSON (useful for CI use cases).
|
Package outputmodulegroups provides a command to output groups of modules ordered by command (apply or destroy) as a list of list in JSON (useful for CI use cases). |
Package renderjson provides the command to render the final terragrunt config, with all variables, includes, and functions resolved, as json.
|
Package renderjson provides the command to render the final terragrunt config, with all variables, includes, and functions resolved, as json. |
Package runall provides the `run-all` command that runs a terraform command against a 'stack' by running the specified command in each subfolder.
|
Package runall provides the `run-all` command that runs a terraform command against a 'stack' by running the specified command in each subfolder. |
Package scaffold provides the command to scaffold a new Terragrunt module.
|
Package scaffold provides the command to scaffold a new Terragrunt module. |
Package terraform contains the logic for interacting with OpenTofu/Terraform.
|
Package terraform contains the logic for interacting with OpenTofu/Terraform. |
creds
Package creds provides a way to obtain credentials through different providers and set them to `opts.Env`.
|
Package creds provides a way to obtain credentials through different providers and set them to `opts.Env`. |
creds/providers
Package providers defines the interface for a provider.
|
Package providers defines the interface for a provider. |
creds/providers/amazonsts
Package amazonsts provides a credentials provider that obtains credentials by making API requests to Amazon STS.
|
Package amazonsts provides a credentials provider that obtains credentials by making API requests to Amazon STS. |
creds/providers/externalcmd
Package externalcmd provides a provider that runs an external command that returns a json string with credentials.
|
Package externalcmd provides a provider that runs an external command that returns a json string with credentials. |
Package terragruntinfo provides the command to emit limited terragrunt state on stdout and exits.
|
Package terragruntinfo provides the command to emit limited terragrunt state on stdout and exits. |
Package validateinputs provides the command to validate the inputs of a Terragrunt configuration file against the variables defined in OpenTofu/Terraform configuration files.
|
Package validateinputs provides the command to validate the inputs of a Terragrunt configuration file against the variables defined in OpenTofu/Terraform configuration files. |
Click to show internal directories.
Click to hide internal directories.