options

Documentation

Index

• Constants
• type Flag
• type Parser
  • func NewParser(raw []string) (p *Parser, sub string)
  • func (p *Parser) SetArgs(args interface{}) bool
  • func (p *Parser) SetFlags(flags interface{})
  • func (p *Parser) UnknownFlags()

Constants

const (
	// Short flags start with a single hyphen (ie. -flag)
	Short = "short"
	// Long flags start with two hyphens (ie. --flag)
	Long = "long"
)

Types

type Flag

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

Flag is an CLI switch that may affect execution

type Parser

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

Parser can be used to read and convert the raw program arguments

func NewParser

func NewParser(raw []string) (p *Parser, sub string)

NewParser does the initial parsing of arguments and returns the resulting Parser

func (*Parser) SetArgs

func (p *Parser) SetArgs(args interface{}) bool

SetArgs attempts to set the entries in 'args', using the previously parsed arguments

func (*Parser) SetFlags

func (p *Parser) SetFlags(flags interface{})

SetFlags attempts to set the entries in 'flags', using the previously parsed arguments

func (*Parser) UnknownFlags

func (p *Parser) UnknownFlags()

UnknownFlags checks for unregistered flags that are set