cli

Documentation

Index

• func DefaultUsageFunc(sf *SortedFlags, c *ffcli.Command, deprecatedFields []string) string
• func Start(cfg *config.Config) error
• type FlagOption
  • func WithReplacement(k, v string) FlagOption
  • func WithSkip(n ...string) FlagOption
  • func WithSkipDeprecated(ok bool) FlagOption
• type SortedFlags
  • func NewSortedFlags(obj interface{}, fs *flag.FlagSet, deprecatedFields []string) *SortedFlags
  • func PopulateFlagSet(obj interface{}, flagSet *flag.FlagSet, opts ...FlagOption) *SortedFlags
  • func (sf *SortedFlags) Len() int
  • func (sf *SortedFlags) Less(i, j int) bool
  • func (sf *SortedFlags) Swap(i, j int)
  • func (sf *SortedFlags) VisitAll(cb func(*flag.Flag))

Functions

func DefaultUsageFunc

func DefaultUsageFunc(sf *SortedFlags, c *ffcli.Command, deprecatedFields []string) string

This is mostly copied from ffcli package

func Start

func Start(cfg *config.Config) error

Types

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 SortedFlags

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

SortedFlags is needed because by default there's no way to provide order for flags

this is kind of an ugly workaround

func NewSortedFlags

func NewSortedFlags(obj interface{}, fs *flag.FlagSet, deprecatedFields []string) *SortedFlags

func PopulateFlagSet

func PopulateFlagSet(obj interface{}, flagSet *flag.FlagSet, opts ...FlagOption) *SortedFlags

func (*SortedFlags) Len

func (sf *SortedFlags) Len() int

func (*SortedFlags) Less

func (sf *SortedFlags) Less(i, j int) bool

func (*SortedFlags) Swap

func (sf *SortedFlags) Swap(i, j int)

func (*SortedFlags) VisitAll

func (sf *SortedFlags) VisitAll(cb func(*flag.Flag))