flags

Documentation

Index

• func Parse()
• func ParseIdAndPort(serviceAndPort string) (string, int)
• type Arg
  • func (a *Arg) IsFile() (bool, []byte)
  • func (a *Arg) IsURL() (bool, *url.URL)
  • func (a *Arg) Val() string
• type BoolFlag
  • func Bool(name string, value bool, usage string) *BoolFlag
  • func (f *BoolFlag) Get() bool
  • func (c BoolFlag) IsSet() bool
• type CommandArgs
  • func Args() *CommandArgs
  • func (a *CommandArgs) First() *Arg
  • func (a *CommandArgs) HasSize(size int) bool
  • func (a *CommandArgs) IsEmpty() bool
• type FlagSet
  • func NewFlagSet(name string) *FlagSet
  • func (fs *FlagSet) BoolFlag(name string, value bool, usage string) *BoolFlag
  • func (fs *FlagSet) IntFlag(name string, value int, usage string) *IntFlag
  • func (fs *FlagSet) ParseArgs() *CommandArgs
  • func (fs *FlagSet) StringArrFlag(name, value, usage string) *StringArrFlag
  • func (fs *FlagSet) StringFlag(name string, value string, usage string) *StringFlag
• type IntFlag
  • func Int(name string, value int, usage string) *IntFlag
  • func (f *IntFlag) Get() int
  • func (c IntFlag) IsSet() bool
• type StringArrFlag
  • func StringArr(name, value, usage string) *StringArrFlag
  • func (c StringArrFlag) IsSet() bool
  • func (f *StringArrFlag) Set(value string) error
  • func (f *StringArrFlag) String() string
  • func (f *StringArrFlag) Values() []string
• type StringFlag
  • func String(name, value, usage string) *StringFlag
  • func (f *StringFlag) Get() string
  • func (c StringFlag) IsSet() bool

Functions

func Parse

func Parse()

Parse the program arguments

func ParseIdAndPort

func ParseIdAndPort(serviceAndPort string) (string, int)

Types

type Arg

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

The main argument of a cli tool

func (*Arg) IsFile

func (a *Arg) IsFile() (bool, []byte)

Return true if argument is file, and return the bytes of the file Otherwise return false and nil

func (*Arg) IsURL

func (a *Arg) IsURL() (bool, *url.URL)

Return true if argument is a parsable url, and return the parsed url Otherwise return false and nil

func (*Arg) Val

func (a *Arg) Val() string

type BoolFlag

type BoolFlag struct {
	Name    string
	Default bool
	// contains filtered or unexported fields
}

Flag representing a boolean

func Bool

func Bool(name string, value bool, usage string) *BoolFlag

Create a new BooleanFlag

func (*BoolFlag) Get

func (f *BoolFlag) Get() bool

func (BoolFlag) IsSet

func (c BoolFlag) IsSet() bool

Check if a given flag was set

type CommandArgs

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

func Args

func Args() *CommandArgs

Retrieve the program arguments

func (*CommandArgs) First

func (a *CommandArgs) First() *Arg

func (*CommandArgs) HasSize

func (a *CommandArgs) HasSize(size int) bool

func (*CommandArgs) IsEmpty

func (a *CommandArgs) IsEmpty() bool

type FlagSet

type FlagSet struct {
	*flag.FlagSet
}

func NewFlagSet

func NewFlagSet(name string) *FlagSet

func (*FlagSet) BoolFlag

func (fs *FlagSet) BoolFlag(name string, value bool, usage string) *BoolFlag

func (*FlagSet) IntFlag

func (fs *FlagSet) IntFlag(name string, value int, usage string) *IntFlag

func (*FlagSet) ParseArgs

func (fs *FlagSet) ParseArgs() *CommandArgs

func (*FlagSet) StringArrFlag

func (fs *FlagSet) StringArrFlag(name, value, usage string) *StringArrFlag

func (*FlagSet) StringFlag

func (fs *FlagSet) StringFlag(name string, value string, usage string) *StringFlag

type IntFlag

type IntFlag struct {
	Name    string
	Default int
	// contains filtered or unexported fields
}

Flag representing a int

func Int

func Int(name string, value int, usage string) *IntFlag

Create a new IntFlag

func (*IntFlag) Get

func (f *IntFlag) Get() int

func (IntFlag) IsSet

func (c IntFlag) IsSet() bool

Check if a given flag was set

type StringArrFlag

type StringArrFlag struct {
	Name    string
	Default string
	// contains filtered or unexported fields
}

A string flag that can be passed multiple times

func StringArr

func StringArr(name, value, usage string) *StringArrFlag

func (StringArrFlag) IsSet

func (c StringArrFlag) IsSet() bool

Check if a given flag was set

func (*StringArrFlag) Set

func (f *StringArrFlag) Set(value string) error

func (*StringArrFlag) String

func (f *StringArrFlag) String() string

func (*StringArrFlag) Values

func (f *StringArrFlag) Values() []string

type StringFlag

type StringFlag struct {
	Name    string
	Default string
	// contains filtered or unexported fields
}

Flag representing string

func String

func String(name, value, usage string) *StringFlag

Create a new StringFlag

func (*StringFlag) Get

func (f *StringFlag) Get() string

func (StringFlag) IsSet

func (c StringFlag) IsSet() bool

Check if a given flag was set