cli

Documentation

Index

• Constants
• type Flag
  • func (f *Flag) IsBool() bool
  • func (f *Flag) Parse(s string) error
  • func (f *Flag) Value() any
• type FlagType
• type Parser
  • func NewParser(version string, tokens []string, flags ...*Flag) *Parser
  • func (p *Parser) Parse() error
  • func (p *Parser) RemainingArgs() []string
  • func (p *Parser) TaskName() string
  • func (p *Parser) WriteHelp(w io.Writer) error

Constants

const (
	FlagTypeBool     = "bool"
	FlagTypeString   = "string"
	FlagTypeDuration = "duration"
)

Types

type Flag

type Flag struct {
	Name         string
	Type         FlagType
	Help         string
	Aliases      []string
	Shorts       []rune
	DefaultValue any
	// contains filtered or unexported fields
}

func (*Flag) IsBool

func (f *Flag) IsBool() bool

func (*Flag) Parse

func (f *Flag) Parse(s string) error

func (*Flag) Value

func (f *Flag) Value() any

type FlagType

type FlagType string

type Parser

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

func NewParser

func NewParser(version string, tokens []string, flags ...*Flag) *Parser

func (*Parser) Parse

func (p *Parser) Parse() error

func (*Parser) RemainingArgs

func (p *Parser) RemainingArgs() []string

func (*Parser) TaskName

func (p *Parser) TaskName() string

func (*Parser) WriteHelp

func (p *Parser) WriteHelp(w io.Writer) error