cli

Documentation

Overview

Package cli provides cli specific functionality.

Index

• Constants
• func Exec(version string, args []string, stdin io.Reader, stdout io.Writer, ...)
• type APIKey
  • func (a *APIKey) ApplyCredentials(req *http.Request) error
  • func (a *APIKey) ExpireAt() time.Time
  • func (a *APIKey) HasExpiration() bool
  • func (a *APIKey) IsExpired() bool
  • func (a *APIKey) Load() (bool, error)
  • func (a *APIKey) Name() string
  • func (a *APIKey) RedactCredentials(req *http.Request)
  • func (a *APIKey) Token() (string, error)
• 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"
)

const (

	// ErrLoginRequired is an error indicating that user has to login to the cloud.
	ErrLoginRequired errors.Kind = "cloud login required"

	// ErrIDPNeedConfirmation is an error indicating the user has multiple providers set up and
	// linking them is needed.
	ErrIDPNeedConfirmation errors.Kind = "the account was already set up with another email provider"

	// ErrEmailNotVerified is an error indicating that user's email need to be verified.
	ErrEmailNotVerified errors.Kind = "email is not verified"
)

const (
	// ProvisionerTerraform indicates that a plan was created by Terraform.
	ProvisionerTerraform = "terraform"

	// ProvisionerOpenTofu indicates that a plan was created by OpenTofu.
	ProvisionerOpenTofu = "opentofu"
)

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"

	// ErrRunCommandNotExecuted represents the error when the command was not executed for whatever reason.
	ErrRunCommandNotExecuted 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 APIKey

type APIKey struct {
	// contains filtered or unexported fields
}

APIKey implements the credential interface.

func (*APIKey) ApplyCredentials

func (a *APIKey) ApplyCredentials(req *http.Request) error

ApplyCredentials applies the API key to the request.

func (*APIKey) ExpireAt

func (a *APIKey) ExpireAt() time.Time

ExpireAt should never be called.

func (*APIKey) HasExpiration

func (a *APIKey) HasExpiration() bool

HasExpiration returns false because the CLI has no information about the expiration of the API key.

func (*APIKey) IsExpired

func (a *APIKey) IsExpired() bool

IsExpired returns false because the CLI has no information about the expiration of the API key.

func (*APIKey) Load

func (a *APIKey) Load() (bool, error)

Load loads the API key from the environment.

func (*APIKey) Name

func (a *APIKey) Name() string

Name returns the name of the authentication method.

func (*APIKey) RedactCredentials

func (a *APIKey) RedactCredentials(req *http.Request)

RedactCredentials redacts the API key from the request.

func (*APIKey) Token

func (a *APIKey) Token() (string, error)

Token returns the API key token.

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
)