cli

Documentation

Index

• func ViperAddArgument(cmd *cobra.Command, a Argument) error
• func ViperAddArguments(cmd *cobra.Command, aList []Argument) error
• func ViperConfig(envPrefix, configName string) error
• func ViperConfigFile() string
• type ArgType
• type Argument
• type Config
• type ConfigError
  • func (c *ConfigError) Error() string
  • func (c *ConfigError) Unwrap() error
• type ConfigNotSupportedProtocolError
  • func (e *ConfigNotSupportedProtocolError) Error() string
• type EmptyCmdArgumentError
  • func (e *EmptyCmdArgumentError) Error() string
• type NoDefaultSetError
  • func (e *NoDefaultSetError) Error() string

Functions

func ViperAddArgument

func ViperAddArgument(cmd *cobra.Command, a Argument) error

ViperAddArgument provides a data driven way to add cli arguments

func ViperAddArguments

func ViperAddArguments(cmd *cobra.Command, aList []Argument) error

ViperAddArguments allows you to pass in many argument configs

func ViperConfig

func ViperConfig(envPrefix, configName string) error

ViperConfig will help configure a project. This includes setting the environment variable prefix, plus the default config file name. For example:

cli.ViperConfig("ears")

func ViperConfigFile

func ViperConfigFile() string

ViperConfigFile is only for visibility/debugging so that the user knows exactly which config file is used

Types

type ArgType

type ArgType string

const (
	ArgTypeInt         ArgType = "int"
	ArgTypeIntSlice    ArgType = "[]int"
	ArgTypeFloat       ArgType = "float"
	ArgTypeFloatSlice  ArgType = "[]float"
	ArgTypeString      ArgType = "string"
	ArgTypeStringSlice ArgType = "[]string"
	ArgTypeBool        ArgType = "bool"
	ArgTypeBoolSlice   ArgType = "[]bool"
)

type Argument

type Argument struct {
	Name        string
	Shorthand   string
	Type        ArgType
	Description string
	Default     interface{}
	LookupKey   string
	Persistent  bool
}

type Config

type Config struct {
	EnvPrefix string
	Name      string
	Paths     []string
}

type ConfigError

type ConfigError struct {
	Err error
	// contains filtered or unexported fields
}

func (*ConfigError) Error

func (c *ConfigError) Error() string

func (*ConfigError) Unwrap

func (c *ConfigError) Unwrap() error

type ConfigNotSupportedProtocolError

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

func (*ConfigNotSupportedProtocolError) Error

func (e *ConfigNotSupportedProtocolError) Error() string

type EmptyCmdArgumentError

type EmptyCmdArgumentError struct {
}

func (*EmptyCmdArgumentError) Error

func (e *EmptyCmdArgumentError) Error() string

type NoDefaultSetError

type NoDefaultSetError struct {
}

func (*NoDefaultSetError) Error

func (e *NoDefaultSetError) Error() string