cliutils

Documentation

Index

• func AddFlags(cmd *cobra.Command, flags []CobraFlagOptions) error
• func BindAWSCreds() error
• func GenerateExampleInCMD(examples []ExampleTemplateOptions) string
• func GetCMDContext(c *cobra.Command, key string) interface{}
• func GetViperEnvVarPrefix(prefix string) string
• func InitViperConfig(options ViperConfigOptions) error
• type CobraFlagOptions
• type CobraViperBindingOptions
• type ExampleTemplateOptions
• type Key
  • func GetCtxKey() Key
• type ViperConfigOptions

Functions

func AddFlags

func AddFlags(cmd *cobra.Command, flags []CobraFlagOptions) error

func BindAWSCreds

func BindAWSCreds() error

func GenerateExampleInCMD

func GenerateExampleInCMD(examples []ExampleTemplateOptions) string

func GetCMDContext

func GetCMDContext(c *cobra.Command, key string) interface{}

GetCMDContext returns the context of a cobra command.

func GetViperEnvVarPrefix

func GetViperEnvVarPrefix(prefix string) string

func InitViperConfig

func InitViperConfig(options ViperConfigOptions) error

Types

type CobraFlagOptions

type CobraFlagOptions struct {
	ShortName                string
	LongName                 string
	Usage                    string
	DefaultValue             interface{}
	FlagType                 string
	FailIfEnvVarBindingFails bool
	IsPersistent             bool
	ViperBindingCfg          CobraViperBindingOptions
	IsRequired               bool
}

type CobraViperBindingOptions

type CobraViperBindingOptions struct {
	EnvVariableNameInViper string
	EnvVariableNameInHost  string
	IsEnabled              bool
}

type ExampleTemplateOptions

type ExampleTemplateOptions struct {
	CLIName     string
	Command     string
	Options     string
	Explanation string
	Title       string
}

type Key

type Key int

func GetCtxKey

func GetCtxKey() Key

type ViperConfigOptions

type ViperConfigOptions struct {
	CfgFile       string
	CfgName       string
	CfgFileType   string
	EnvVarsPrefix string
}