shell

Documentation

Index

• func GetExitCode(err error) (int, error)
• 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 RunShellCommandAndCaptureOutput(terragruntOptions *options.TerragruntOptions, command string, args ...string) (string, error)
• func RunShellCommandWithOutput(terragruntOptions *options.TerragruntOptions, command string, args ...string) (string, error)
• func RunTerraformCommand(terragruntOptions *options.TerragruntOptions, args ...string) error
• func RunTerraformCommandAndCaptureOutput(terragruntOptions *options.TerragruntOptions, args ...string) (string, error)
• func RunTerraformCommandWithOutput(terragruntOptions *options.TerragruntOptions, args ...string) (string, error)
• type SignalsForwarder
  • func NewSignalsForwarder(signals []os.Signal, c *exec.Cmd, logger *log.Logger, 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 errors.MultiError type, the error is returned.

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 RunShellCommandAndCaptureOutput

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

Run the specified shell command with the specified arguments. Capture the command's stdout and return it as a string.

func RunShellCommandWithOutput

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

Run the specified shell command with the specified arguments. Connect the command's stdin, stdout, and stderr to the currently running app.

func RunTerraformCommand

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

Run the given Terraform command

func RunTerraformCommandAndCaptureOutput

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

Run the given Terraform command and return the stdout as a string

func RunTerraformCommandWithOutput

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

Run the given Terraform command

Types

type SignalsForwarder

type SignalsForwarder chan os.Signal

func NewSignalsForwarder

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

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

func (*SignalsForwarder) Close

func (signalChannel *SignalsForwarder) Close() error