cliconfig

Documentation

Overview

Package cliconfig implements the parser and load of Terramate CLI Configuration files (.terramaterc and terramate.rc).

Index

• Constants
• type Config
  • func Load() (cfg Config, err error)
  • func LoadFrom(fname string) (Config, error)

Constants

const (
	// ErrInvalidAttributeType indicates the attribute has an invalid type.
	ErrInvalidAttributeType errors.Kind = "attribute with invalid type"

	// ErrUnrecognizedAttribute indicates the attribute is unrecognized.
	ErrUnrecognizedAttribute errors.Kind = "unrecognized attribute"
)

const DirEnv = "HOME"

DirEnv is the environment variable used to define the config location.

const Filename = ".terramaterc"

Filename is the name of the CLI configuration file.

Types

type Config

type Config struct {
	DisableCheckpoint          bool
	DisableCheckpointSignature bool
	UserTerramateDir           string
}

Config is the evaluated CLI configuration options.

func Load

func Load() (cfg Config, err error)

Load loads (parses and evaluates) all CLI configuration files.

func LoadFrom

func LoadFrom(fname string) (Config, error)

LoadFrom loads the CLI configuration file from fname.