cli

Documentation

Index

• Constants
• func DefaultUsageFunc(sf *pflag.FlagSet, c *cobra.Command) string
• func GradientBanner(banner string) string
• func InitLogging()
• func NewViper(prefix string) *viper.Viper
• func PopulateFlagSet(obj interface{}, flagSet *pflag.FlagSet, vpr *viper.Viper, opts ...FlagOption) *pflag.FlagSet
• func StartAgent(_ *config.Agent) error
• func Unmarshal(vpr *viper.Viper, cfg interface{}) error
• type CmdRunFn
  • func CreateCmdRunFn(cfg interface{}, vpr *viper.Viper, fn CmdRunFn) CmdRunFn
• type FlagOption
  • func WithReplacement(k, v string) FlagOption
  • func WithSkip(n ...string) FlagOption
  • func WithSkipDeprecated(ok bool) FlagOption
• type Server
  • func NewServer(c *config.Server) (*Server, error)
  • func (s *Server) Start() error
  • func (s *Server) Stop()

Constants

const OptionsEnd = "--"

https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html#tag_12_02

Functions

func DefaultUsageFunc

func DefaultUsageFunc(sf *pflag.FlagSet, c *cobra.Command) string

TODO: Do we want to keep this or use cobra default one? Maybe banner + cobra default? Or something else? This is mostly copied from ffcli package

func GradientBanner

func GradientBanner(banner string) string

func InitLogging

func InitLogging()

func NewViper

func NewViper(prefix string) *viper.Viper

func PopulateFlagSet

func PopulateFlagSet(obj interface{}, flagSet *pflag.FlagSet, vpr *viper.Viper, opts ...FlagOption) *pflag.FlagSet

func StartAgent

func StartAgent(_ *config.Agent) error

func Unmarshal

func Unmarshal(vpr *viper.Viper, cfg interface{}) error

Types

type CmdRunFn

type CmdRunFn func(cmd *cobra.Command, args []string) error

func CreateCmdRunFn

func CreateCmdRunFn(cfg interface{}, vpr *viper.Viper, fn CmdRunFn) CmdRunFn

type FlagOption

type FlagOption func(*options)

func WithReplacement

func WithReplacement(k, v string) FlagOption

func WithSkip

func WithSkip(n ...string) FlagOption

func WithSkipDeprecated

func WithSkipDeprecated(ok bool) FlagOption

WithSkipDeprecated specifies that fields marked as deprecated won't be parsed. By default PopulateFlagSet parses them but not shows in Usage; setting this option to true causes PopulateFlagSet to skip parsing.

type Server

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

func NewServer

func NewServer(c *config.Server) (*Server, error)

func (*Server) Start

func (s *Server) Start() error

func (*Server) Stop

func (s *Server) Stop()