cli

Documentation

Index

• Constants
• Variables
• type App
  • func NewApp(writer io.Writer, errWriter io.Writer) *App
  • func (app *App) Run(args []string) error
  • func (app *App) RunContext(ctx context.Context, args []string) error
• type ProviderCache
  • func InitProviderCacheServer(opts *options.TerragruntOptions) (*ProviderCache, error)
  • func (cache *ProviderCache) TerraformCommandHook(ctx context.Context, opts *options.TerragruntOptions, args []string) (*shell.CmdOutput, error)

Constants

const (
	CommandNameSpinUp      = "spin-up"
	CommandNameTearDown    = "tear-down"
	CommandNamePlanAll     = "plan-all"
	CommandNameApplyAll    = "apply-all"
	CommandNameDestroyAll  = "destroy-all"
	CommandNameOutputAll   = "output-all"
	CommandNameValidateAll = "validate-all"
)

The following commands are DEPRECATED

const AppHelpTemplate = `` /* 832-byte string literal not displayed */

const AppVersionTemplate = `terragrunt version {{.App.Version}}
`

const CommandHelpTemplate = `` /* 975-byte string literal not displayed */

Variables

var (
	// HTTPStatusCacheProviderReg is regular expression to determine the success result of the command `terraform init`.
	// The reg matches if the text contains "423 Locked", for example:
	//
	// - registry.terraform.io/hashicorp/template: could not query provider registry for registry.terraform.io/hashicorp/template: 423 Locked.
	//
	// It also will match cases where terminal window is small enough so that terraform splits output in multiple lines, like following:
	//
	//    ╷
	//    │ Error: Failed to install provider
	//    │
	//    │ Error while installing snowflake-labs/snowflake v0.89.0: could not query
	//    │ provider registry for registry.terraform.io/snowflake-labs/snowflake: 423
	//    │ Locked
	//    ╵
	HTTPStatusCacheProviderReg = regexp.MustCompile(`(?smi)` + strconv.Itoa(cacheProviderHTTPStatusCode) + `.*` + http.StatusText(cacheProviderHTTPStatusCode))
)

Types

type App

type App struct {
	*cli.App
}

func NewApp

func NewApp(writer io.Writer, errWriter io.Writer) *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

type ProviderCache

type ProviderCache struct {
	*cache.Server
	// contains filtered or unexported fields
}

func InitProviderCacheServer

func InitProviderCacheServer(opts *options.TerragruntOptions) (*ProviderCache, error)

func (*ProviderCache) TerraformCommandHook

func (cache *ProviderCache) TerraformCommandHook(ctx context.Context, opts *options.TerragruntOptions, args []string) (*shell.CmdOutput, error)