args

Documentation

Index

• type ArgParser
  • func (ap *ArgParser) AddCommand(name string, help string) error
  • func (ap *ArgParser) AddFlag(name string, help string, abbr rune) error
  • func (ap *ArgParser) AddOption(name string, help string, abbr rune, defaultsTo string, allowed []string) error
  • func (ap *ArgParser) Help()
  • func (ap *ArgParser) Init(name string, description string)
  • func (ap *ArgParser) Parse() (*ArgResults, error)
• type ArgResults

Types

type ArgParser

type ArgParser struct {
	MaxLineLength   uint
	CommandRequired bool
	CommandsHelpMsg string
	FlagsHelpMsg    string
	OptionsHelpMsg  string
	// contains filtered or unexported fields
}

func (*ArgParser) AddCommand

func (ap *ArgParser) AddCommand(name string, help string) error

func (*ArgParser) AddFlag

func (ap *ArgParser) AddFlag(name string, help string, abbr rune) error

func (*ArgParser) AddOption

func (ap *ArgParser) AddOption(
	name string, help string, abbr rune, defaultsTo string, allowed []string,
) error

func (*ArgParser) Help

func (ap *ArgParser) Help()

func (*ArgParser) Init

func (ap *ArgParser) Init(name string, description string)

func (*ArgParser) Parse

func (ap *ArgParser) Parse() (*ArgResults, error)

type ArgResults

type ArgResults struct {
	Flag       map[string]bool
	Option     map[string]string
	Positional []string
	Command    string
}