cli

Documentation

Index

• func LoadConfig[T Config]() (*T, error)
• func SetupConfiguration(c *cobra.Command)
• type AppSettings
• type CLI
  • func New[T Config](app AppSettings) *CLI
  • func (c *CLI) Close()
  • func (c *CLI) GetRoot() *cobra.Command
  • func (c *CLI) GetVersionString() string
  • func (c *CLI) Run()
• type CleanUpHandler
• type Config
• type ConfigMock
  • func (c ConfigMock) SetDefaults()
  • func (c ConfigMock) Validate() error
• type DefaultConfigHandler

Functions

func LoadConfig

func LoadConfig[T Config]() (*T, error)

func SetupConfiguration

func SetupConfiguration(c *cobra.Command)

Types

type AppSettings

type AppSettings struct {
	Name        string
	Description string
	ConfigPath  string // Where this CLI config.yml?
	EnvPrefix   string // environment variable MYAPP_.....
	GitVersion  string
	GitRevision string
}

type CLI

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

func New

func New[T Config](app AppSettings) *CLI

New generates a CLI instance

func (*CLI) Close

func (c *CLI) Close()

func (*CLI) GetRoot

func (c *CLI) GetRoot() *cobra.Command

func (*CLI) GetVersionString

func (c *CLI) GetVersionString() string

func (*CLI) Run

func (c *CLI) Run()

type CleanUpHandler

type CleanUpHandler func()

type Config

type Config interface {
	SetDefaults()
	Validate() error
}

type ConfigMock

type ConfigMock struct {
	Foo string `json:"foo"`
}

func (ConfigMock) SetDefaults

func (c ConfigMock) SetDefaults()

func (ConfigMock) Validate

func (c ConfigMock) Validate() error

type DefaultConfigHandler

type DefaultConfigHandler func()