cli

Documentation

Index

• type Command
  • func (c *Command) AddCommand(cmd *Command)
  • func (c *Command) Execute(args []string) error
  • func (c *Command) Flags() *FlagSet
  • func (c *Command) Name() string
  • func (c *Command) Usage() string
• type Flag
  • func NewFlag[T flagTypes](name, usage string, setValueFunc func(*FlagValue[T], string) error, ...) *Flag[T]
  • func (f *Flag[T]) Default(defaultValue T) *Flag[T]
  • func (f *Flag[T]) Deprecated(msg string) *Flag[T]
  • func (f *Flag[_]) Flag() *pflag.Flag
  • func (f *Flag[T]) Hidden() *Flag[T]
  • func (f *Flag[T]) Required() *Flag[T]
  • func (f *Flag[T]) Shorthand(p string) *Flag[T]
  • func (f *Flag[T]) ShorthandDeprecated(msg string) *Flag[T]
  • func (f *Flag[_]) Value() string
  • func (f *Flag[T]) Var(p *T) *Flag[T]
• type FlagSet
  • func NewFlagSet(name string, errorHandling pflag.ErrorHandling) *FlagSet
  • func (fs *FlagSet) AddFlagSet(v *FlagSet)
  • func (fs *FlagSet) Args() []string
  • func (fs *FlagSet) Bool(name, usage string) *Flag[bool]
  • func (fs *FlagSet) Copy() *FlagSet
  • func (fs *FlagSet) Duration(name, usage string) *Flag[time.Duration]
  • func (fs *FlagSet) Float32(name, usage string) *Flag[float32]
  • func (fs *FlagSet) HasFlags() bool
  • func (fs *FlagSet) Int(name, usage string) *Flag[int]
  • func (fs *FlagSet) Int64(name, usage string) *Flag[int64]
  • func (fs *FlagSet) Len() int
  • func (fs *FlagSet) OnelineUsage(leftPadding, wrap int) string
  • func (fs *FlagSet) Parse(args []string) error
  • func (fs *FlagSet) String(name, usage string) *Flag[string]
  • func (fs *FlagSet) StringArray(name, usage string) *Flag[[]string]
  • func (fs *FlagSet) Uint(name, usage string) *Flag[uint]
  • func (fs *FlagSet) Usage() string
• type FlagValue
  • func (f *FlagValue[T]) Set(val string) error
  • func (f *FlagValue[T]) String() string
  • func (f *FlagValue[T]) Type() string

Types

type Command

type Command struct {
	Use   string
	Short string
	Long  string
	Run   func(ctx context.Context, cmd *Command, args []string) error
	// contains filtered or unexported fields
}

func (*Command) AddCommand

func (c *Command) AddCommand(cmd *Command)

func (*Command) Execute

func (c *Command) Execute(args []string) error

func (*Command) Flags

func (c *Command) Flags() *FlagSet

func (*Command) Name

func (c *Command) Name() string

func (*Command) Usage

func (c *Command) Usage() string

type Flag

type Flag[T flagTypes] struct {
	// contains filtered or unexported fields
}

func NewFlag

func NewFlag[T flagTypes](name, usage string, setValueFunc func(*FlagValue[T], string) error, setDefaultValueFunc func(*pflag.Flag, T) error, toStr func(T) string) *Flag[T]

func (*Flag[T]) Default

func (f *Flag[T]) Default(defaultValue T) *Flag[T]

func (*Flag[T]) Deprecated

func (f *Flag[T]) Deprecated(msg string) *Flag[T]

func (*Flag[_]) Flag

func (f *Flag[_]) Flag() *pflag.Flag

func (*Flag[T]) Hidden

func (f *Flag[T]) Hidden() *Flag[T]

func (*Flag[T]) Required

func (f *Flag[T]) Required() *Flag[T]

func (*Flag[T]) Shorthand

func (f *Flag[T]) Shorthand(p string) *Flag[T]

func (*Flag[T]) ShorthandDeprecated

func (f *Flag[T]) ShorthandDeprecated(msg string) *Flag[T]

func (*Flag[_]) Value

func (f *Flag[_]) Value() string

func (*Flag[T]) Var

func (f *Flag[T]) Var(p *T) *Flag[T]

type FlagSet

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

func NewFlagSet

func NewFlagSet(name string, errorHandling pflag.ErrorHandling) *FlagSet

func (*FlagSet) AddFlagSet

func (fs *FlagSet) AddFlagSet(v *FlagSet)

func (*FlagSet) Args

func (fs *FlagSet) Args() []string

func (*FlagSet) Bool

func (fs *FlagSet) Bool(name, usage string) *Flag[bool]

func (*FlagSet) Copy

func (fs *FlagSet) Copy() *FlagSet

func (*FlagSet) Duration

func (fs *FlagSet) Duration(name, usage string) *Flag[time.Duration]

func (*FlagSet) Float32

func (fs *FlagSet) Float32(name, usage string) *Flag[float32]

func (*FlagSet) HasFlags

func (fs *FlagSet) HasFlags() bool

func (*FlagSet) Int

func (fs *FlagSet) Int(name, usage string) *Flag[int]

func (*FlagSet) Int64

func (fs *FlagSet) Int64(name, usage string) *Flag[int64]

func (*FlagSet) Len

func (fs *FlagSet) Len() int

func (*FlagSet) OnelineUsage

func (fs *FlagSet) OnelineUsage(leftPadding, wrap int) string

func (*FlagSet) Parse

func (fs *FlagSet) Parse(args []string) error

func (*FlagSet) String

func (fs *FlagSet) String(name, usage string) *Flag[string]

func (*FlagSet) StringArray

func (fs *FlagSet) StringArray(name, usage string) *Flag[[]string]

func (*FlagSet) Uint

func (fs *FlagSet) Uint(name, usage string) *Flag[uint]

func (*FlagSet) Usage

func (fs *FlagSet) Usage() string

type FlagValue

type FlagValue[T flagTypes] struct {
	// contains filtered or unexported fields
}

func (*FlagValue[T]) Set

func (f *FlagValue[T]) Set(val string) error

func (*FlagValue[T]) String

func (f *FlagValue[T]) String() string

func (*FlagValue[T]) Type

func (f *FlagValue[T]) Type() string