root

Documentation

Index

• func AddCommand(c *cobra.Command, fc any)
• func CreateCmd(parent *cobra.Command, use, short string, obj interface{ ... }) *cobra.Command
• func InitFlags(f any, pf, persistent *pflag.FlagSet) error
• func NewVersionValue() *versionValue
• func Run()
• func RunCmd(parent *cobra.Command, use, short string, obj interface{ ... })
• func SplitSeps(s string, seps string) []string
• type CmdLongHelper
• type DefaultPlagValuesAware
• type Enum
  • func NewEnum(allows []string, val *string, defaultVal string) *Enum
  • func NewEnumInt(allows []string, val *int, defaultVal int) *Enum
  • func (e *Enum) Set(v string) error
  • func (e Enum) String() string
  • func (e *Enum) Type() string
• type EnumType

Functions

func AddCommand

func AddCommand(c *cobra.Command, fc any)

func CreateCmd

func CreateCmd(parent *cobra.Command, use, short string, obj interface {
	Run(*cobra.Command, []string) error
}) *cobra.Command

func InitFlags

func InitFlags(f any, pf, persistent *pflag.FlagSet) error

func NewVersionValue

func NewVersionValue() *versionValue

func Run

func Run()

func RunCmd

func RunCmd(parent *cobra.Command, use, short string, obj interface {
	Run(*cobra.Command, []string) error
})

func SplitSeps

func SplitSeps(s string, seps string) []string

Types

type CmdLongHelper

type CmdLongHelper interface {
	LongHelp() string
}

type DefaultPlagValuesAware

type DefaultPlagValuesAware interface {
	DefaultPlagValues(name string) (any, bool)
}

type Enum

type Enum struct {
	Allows    []string
	Value     *string
	ValueInt  *int
	ValueType EnumType
}

func NewEnum

func NewEnum(allows []string, val *string, defaultVal string) *Enum

func NewEnumInt

func NewEnumInt(allows []string, val *int, defaultVal int) *Enum

func (*Enum) Set

func (e *Enum) Set(v string) error

Set must have pointer receiver so it doesn't change the value of a copy

func (Enum) String

func (e Enum) String() string

String is used both by fmt.Print and by Cobra in help text

func (*Enum) Type

func (e *Enum) Type() string

Type is only used in help text

type EnumType

type EnumType int

const (
	EnumString EnumType = iota
	EnumInt
)