shell

Documentation

Index

• func GetExitCode(err error) (int, error)
• func PrepareConsole(terragruntOptions *options.TerragruntOptions)
• func PromptUserForInput(prompt string, terragruntOptions *options.TerragruntOptions) (string, error)
• func PromptUserForYesNo(prompt string, terragruntOptions *options.TerragruntOptions) (bool, error)
• func RunShellCommand(terragruntOptions *options.TerragruntOptions, command string, args ...string) error
• func RunTerraformCommand(terragruntOptions *options.TerragruntOptions, args ...string) error
• type CmdOutput
  • func RunShellCommandWithOutput(terragruntOptions *options.TerragruntOptions, workingDir string, ...) (*CmdOutput, error)
  • func RunTerraformCommandWithOutput(terragruntOptions *options.TerragruntOptions, args ...string) (*CmdOutput, error)
• type SignalsForwarder
  • func NewSignalsForwarder(signals []os.Signal, c *exec.Cmd, logger *logrus.Entry, cmdChannel chan error) SignalsForwarder
  • func (signalChannel *SignalsForwarder) Close() error

Functions

func GetExitCode

func GetExitCode(err error) (int, error)

Return the exit code of a command. If the error does not implement errors.IErrorCode or is not an exec.ExitError or *multierror.Error type, the error is returned.

func PrepareConsole

func PrepareConsole(terragruntOptions *options.TerragruntOptions)

func PromptUserForInput

func PromptUserForInput(prompt string, terragruntOptions *options.TerragruntOptions) (string, error)

Prompt the user for text in the CLI. Returns the text entered by the user.

func PromptUserForYesNo

func PromptUserForYesNo(prompt string, terragruntOptions *options.TerragruntOptions) (bool, error)

Prompt the user for a yes/no response and return true if they entered yes.

func RunShellCommand

func RunShellCommand(terragruntOptions *options.TerragruntOptions, command string, args ...string) error

Run the given shell command

func RunTerraformCommand

func RunTerraformCommand(terragruntOptions *options.TerragruntOptions, args ...string) error

Run the given Terraform command

Types

type CmdOutput

type CmdOutput struct {
	Stdout string
	Stderr string
}

func RunShellCommandWithOutput

func RunShellCommandWithOutput(
	terragruntOptions *options.TerragruntOptions,
	workingDir string,
	suppressStdout bool,
	allocatePseudoTty bool,
	command string,
	args ...string,
) (*CmdOutput, error)

Run the specified shell command with the specified arguments. Connect the command's stdin, stdout, and stderr to the currently running app. The command can be executed in a custom working directory by using the parameter `workingDir`. Terragrunt working directory will be assumed if empty string.

func RunTerraformCommandWithOutput

func RunTerraformCommandWithOutput(terragruntOptions *options.TerragruntOptions, args ...string) (*CmdOutput, error)

Run the given Terraform command, writing its stdout/stderr to the terminal AND returning stdout/stderr to this method's caller

type SignalsForwarder

type SignalsForwarder chan os.Signal

func NewSignalsForwarder

func NewSignalsForwarder(signals []os.Signal, c *exec.Cmd, logger *logrus.Entry, cmdChannel chan error) SignalsForwarder

Forwards signals to a command, waiting for the command to finish.

func (*SignalsForwarder) Close

func (signalChannel *SignalsForwarder) Close() error