shared

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: 9 Imported by: 0

Documentation

Overview

Package shared provides flags that are shared by multiple commands.

This package is underutilized right now, as some more serious refactoring is needed to make sure all shared flags use this package instead of reusing flags from other commands.

Index

Constants

View Source
const (
	AllFlagName  = "all"
	AllFlagAlias = "a"
)
View Source
const (
	BackendBootstrapFlagName        = "backend-bootstrap"
	BackendRequireBootstrapFlagName = "backend-require-bootstrap"
	DisableBucketUpdateFlagName     = "disable-bucket-update"
)
View Source
const (
	FilterFlagName             = "filter"
	FilterAffectedFlagName     = "filter-affected"
	FilterAllowDestroyFlagName = "filter-allow-destroy"
	FilterFileFlagName         = "filters-file"
	NoFilterFileFlagName       = "no-filters-file"
)
View Source
const (
	IAMAssumeRoleFlagName                 = "iam-assume-role"
	IAMAssumeRoleDurationFlagName         = "iam-assume-role-duration"
	IAMAssumeRoleSessionNameFlagName      = "iam-assume-role-session-name"
	IAMAssumeRoleWebIdentityTokenFlagName = "iam-assume-role-web-identity-token"
)
View Source
const (
	QueueIgnoreErrorsFlagName        = "queue-ignore-errors"
	QueueIgnoreDAGOrderFlagName      = "queue-ignore-dag-order"
	QueueExcludeExternalFlagName     = "queue-exclude-external"
	QueueExcludeDirFlagName          = "queue-exclude-dir"
	QueueExcludesFileFlagName        = "queue-excludes-file"
	QueueIncludeDirFlagName          = "queue-include-dir"
	QueueIncludeExternalFlagName     = "queue-include-external"
	QueueStrictIncludeFlagName       = "queue-strict-include"
	QueueIncludeUnitsReadingFlagName = "queue-include-units-reading"
)
View Source
const (
	RootFileNameFlagName  = "root-file-name"
	NoIncludeRootFlagName = "no-include-root"
	NoShellFlagName       = "no-shell"
	NoHooksFlagName       = "no-hooks"
)
View Source
const (
	AuthProviderCmdFlagName = "auth-provider-cmd"
)
View Source
const (
	ConfigFlagName = "config"
)
View Source
const (
	DownloadDirFlagName = "download-dir"
)
View Source
const (
	FailFastFlagName = "fail-fast"
)
View Source
const (
	FeatureFlagName = "feature"
)
View Source
const (
	GraphFlagName = "graph"
)
View Source
const (
	InputsDebugFlagName = "inputs-debug"
)
View Source
const (
	ParallelismFlagName = "parallelism"
)
View Source
const (
	TFPathFlagName = "tf-path"
)

Variables

This section is empty.

Functions

func NewAllFlag

func NewAllFlag(opts *options.TerragruntOptions, prefix flags.Prefix) *flags.Flag

NewAllFlag creates the --all flag for running commands across all units in a stack.

func NewAuthProviderCmdFlag

func NewAuthProviderCmdFlag(opts *options.TerragruntOptions, prefix flags.Prefix, commandName string) *flags.Flag

NewAuthProviderCmdFlag creates a flag for specifying the auth provider command.

func NewBackendFlags

func NewBackendFlags(opts *options.TerragruntOptions, prefix flags.Prefix) clihelper.Flags

NewBackendFlags defines backend-related flags that should be available to both `run` and `backend` commands.

func NewConfigFlag

func NewConfigFlag(opts *options.TerragruntOptions, prefix flags.Prefix, commandName string) *flags.Flag

NewConfigFlag creates a flag for specifying the Terragrunt config file path.

func NewDownloadDirFlag

func NewDownloadDirFlag(opts *options.TerragruntOptions, prefix flags.Prefix, commandName string) *flags.Flag

NewDownloadDirFlag creates a flag for specifying the download directory path.

func NewFailFastFlag

func NewFailFastFlag(opts *options.TerragruntOptions) *flags.Flag

NewFailFastFlag creates the --fail-fast flag for stopping execution on the first error.

func NewFeatureFlags

func NewFeatureFlags(opts *options.TerragruntOptions, prefix flags.Prefix) clihelper.Flags

NewFeatureFlags defines the feature flag map that should be available to both `run` and `backend` commands.

func NewFilterFlags

func NewFilterFlags(l log.Logger, opts *options.TerragruntOptions) clihelper.Flags

NewFilterFlags creates flags for specifying filter queries.

func NewGraphFlag

func NewGraphFlag(opts *options.TerragruntOptions, prefix flags.Prefix) *flags.Flag

NewGraphFlag creates the --graph flag for running commands following the DAG.

func NewIAMAssumeRoleFlags

func NewIAMAssumeRoleFlags(opts *options.TerragruntOptions, prefix flags.Prefix, commandName string) clihelper.Flags

NewIAMAssumeRoleFlags creates flags for IAM assume role configuration.

func NewInputsDebugFlag

func NewInputsDebugFlag(opts *options.TerragruntOptions, prefix flags.Prefix, commandName string) *flags.Flag

NewInputsDebugFlag creates a flag for enabling inputs debug output.

func NewParallelismFlag

func NewParallelismFlag(opts *options.TerragruntOptions) *flags.Flag

NewParallelismFlag creates a flag for specifying parallelism level.

func NewQueueFlags

func NewQueueFlags(opts *options.TerragruntOptions, prefix flags.Prefix) clihelper.Flags

NewQueueFlags creates the flags used for queue control

func NewScaffoldingFlags

func NewScaffoldingFlags(opts *options.TerragruntOptions, prefix flags.Prefix) clihelper.Flags

NewScaffoldingFlags creates the flags shared between catalog and scaffold commands.

func NewTFPathFlag

func NewTFPathFlag(opts *options.TerragruntOptions) *flags.Flag

NewTFPathFlag creates a flag for specifying the OpenTofu/Terraform binary path.

Types

type AllGraphFlagsError

type AllGraphFlagsError byte

AllGraphFlagsError is returned when both --all and --graph flags are used simultaneously.

func (*AllGraphFlagsError) Error

func (err *AllGraphFlagsError) Error() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL