cli

Documentation

Overview

Package cli provides cli specific functionality.

Index

• Constants
• func Exec(version string, args []string, stdin io.Reader, stdout io.Writer, ...)
• type UIMode

Constants

const (
	// ErrCurrentHeadIsOutOfDate indicates the local HEAD revision is outdated.
	ErrCurrentHeadIsOutOfDate errors.Kind = "current HEAD is out-of-date with the remote base branch"
	// ErrOutdatedGenCodeDetected indicates outdated generated code detected.
	ErrOutdatedGenCodeDetected errors.Kind = "outdated generated code detected"
	// ErrRootCfgInvalidDir indicates that a root configuration was found outside root
	ErrRootCfgInvalidDir errors.Kind = "root config found outside root dir"
)

const (
	// ErrRunFailed represents the error when the execution fails, whatever the reason.
	ErrRunFailed errors.Kind = "execution failed"

	// ErrRunCanceled represents the error when the execution was canceled.
	ErrRunCanceled errors.Kind = "execution canceled"

	// ErrRunCommandNotFound represents the error when the command cannot be found
	// in the system.
	ErrRunCommandNotFound errors.Kind = "command not found"
)

Functions

func Exec

func Exec(
	version string,
	args []string,
	stdin io.Reader,
	stdout io.Writer,
	stderr io.Writer,
)

Exec will execute terramate with the provided flags defined on args. Only flags should be on the args slice.

Results will be written on stdout, according to the command flags and errors/warnings written on stderr. Exec will abort the process with a status code different than zero in the case of fatal errors.

Sometimes sub commands may be executed, the provided stdin will be passed to then as the sub process stdin.

Each Exec call is completely isolated from each other (no shared state) as far as the parameters are not shared between the run calls.

Types

type UIMode

type UIMode int

UIMode defines different modes of operation for the cli.

const (
	// HumanMode is the default normal mode when Terramate is executed at the user's machine.
	HumanMode UIMode = iota
	// AutomationMode is the mode when Terramate executes in the CI/CD environment.
	AutomationMode
)