getoptions

Feb 22, 2024

Changes in this version

+ var ErrorNotFound = fmt.Errorf("not found")

type GetOpt

+ func (gopt *GetOpt) GetRequiredArg(args []string, sections ...HelpSection) (string, []string, error)

+ func (gopt *GetOpt) GetRequiredArgFloat64(args []string, sections ...HelpSection) (float64, []string, error)

+ func (gopt *GetOpt) GetRequiredArgInt(args []string, sections ...HelpSection) (int, []string, error)

+ func (gopt *GetOpt) SetValue(name string, value ...string) error

+ func (gopt *GetOpt) SuggestedValues(values ...string) ModifyFn

type HelpSection

+ const HelpNone

Nov 5, 2023

Changes in this version

type GetOpt

+ func (gopt *GetOpt) SetCalled(called bool) ModifyFn

Mar 12, 2023

Changes in this version

type GetOpt

+ func (gopt *GetOpt) HelpSynopsisArg(arg, description string) *GetOpt

Dec 5, 2022

Changes in this version

+ var ErrorParsing = errors.New("")

Jan 2, 2022

Changes in this version

+ var Logger = log.New(ioutil.Discard, "DEBUG: ", log.Ldate | log.Ltime | log.Lshortfile)

+ var Writer io.Writer = os.Stderr

+ func InterruptContext() (ctx context.Context, cancel context.CancelFunc, done chan struct{})

type GetOpt

+ func (gopt *GetOpt) Float64Slice(name string, min, max int, fns ...ModifyFn) *[]float64

+ func (gopt *GetOpt) Float64SliceVar(p *[]float64, name string, min, max int, fns ...ModifyFn)

+ func (gopt *GetOpt) UnsetOptions() *GetOpt

+ func (gopt *GetOpt) ValidValues(values ...string) ModifyFn

type HelpSection

+ const HelpCommandInfo

Oct 21, 2020

Changes in this version

type GetOpt

+ func (gopt *GetOpt) Float64Optional(name string, def float64, fns ...ModifyFn) *float64

+ func (gopt *GetOpt) Float64VarOptional(p *float64, name string, def float64, fns ...ModifyFn)

Oct 11, 2020

Changes in this version

+ var ErrorHelpCalled = fmt.Errorf("help called")

Mar 25, 2020

Changes in this version

type GetOpt

+ func (gopt *GetOpt) GetEnv(name string) ModifyFn

Oct 24, 2019

Changes in this version

type GetOpt

+ func (gopt *GetOpt) InterruptContext() (ctx context.Context, cancel context.CancelFunc, done chan struct{})

+ func (gopt *GetOpt) NewCommand(name string, description string) *GetOpt

Sep 24, 2019

Changes in this version

type GetOpt

+ func (gopt *GetOpt) HelpSynopsisArgs(args string) *GetOpt

Aug 30, 2019

Changes in this version

+ type CommandFn func(*GetOpt, []string) error

type GetOpt

+ CommandFn CommandFn

+ func NewCommand() *GetOpt

+ func (gopt *GetOpt) Dispatch(helpOptionName string, args []string) error

+ func (gopt *GetOpt) HelpCommand(description string) *GetOpt

+ func (gopt *GetOpt) SetCommandFn(fn CommandFn) *GetOpt

Jul 28, 2019

Changes in this version

type GetOpt

+ func (gopt *GetOpt) Command(options *GetOpt)

+ func (gopt *GetOpt) CustomCompletion(list []string) *GetOpt

+ func (gopt *GetOpt) Self(name string, description string) *GetOpt

+ func (gopt *GetOpt) SetOption(opts ...*option.Option) *GetOpt

+ func (gopt *GetOpt) StringMapVar(m *map[string]string, name string, min, max int, fns ...ModifyFn)

+ func (gopt *GetOpt) Value(name string) interface{}

+ type HelpSection int

+ const HelpCommandList

+ const HelpName

+ const HelpOptionList

+ const HelpSynopsis

+ type Mode int

+ const Bundling

+ const Normal

+ const SingleDash

+ type UnknownMode int

+ const Fail

+ const Pass

+ const Warn

Mar 2, 2019

Changes in this version

+ var HelpOptionsHeader = "OPTIONS"

+ var HelpRequiredOptionsHeader = "REQUIRED PARAMETERS"

+ var HelpSynopsisHeader = "SYNOPSIS"

type GetOpt

+ func (gopt *GetOpt) ArgName(name string) ModifyFn

+ func (gopt *GetOpt) CalledAs(name string) string

+ func (gopt *GetOpt) Description(msg string) ModifyFn

+ func (gopt *GetOpt) Help() string

+ func (gopt *GetOpt) HelpOptionList() string

+ func (gopt *GetOpt) HelpSynopsis() string

Feb 19, 2019

Changes in this version

+ var ErrorMissingRequiredOption = "Missing required option '%s'!"

type GetOpt

+ func (gopt *GetOpt) Alias(alias ...string) ModifyFn

+ func (gopt *GetOpt) Required(msg ...string) ModifyFn

+ type ModifyFn func(*option)

Aug 16, 2017

Changes in this version

type GetOpt

+ func (gopt *GetOpt) IntSlice(name string, min, max int, aliases ...string) *[]int

+ func (gopt *GetOpt) IntSliceVar(p *[]int, name string, min, max int, aliases ...string)

+ func (gopt *GetOpt) SetMapKeysToLower()

+ func (gopt *GetOpt) StringSliceVar(p *[]string, name string, min, max int, aliases ...string)

Mar 15, 2017

Changes in this version

type GetOpt

+ func (gopt *GetOpt) IntSliceMulti(name string, min, max int, aliases ...string) *[]int

+ func (gopt *GetOpt) StringMapMulti(name string, min, max int, aliases ...string) map[string]string

Feb 4, 2017

Changes in this version

+ var Debug = log.New(ioutil.Discard, "DEBUG: ", log.Ldate | log.Ltime | log.Lshortfile)

+ var ErrorArgumentIsNotKeyValue = "Argument error for option '%s': Should be of type 'key=value'!"

+ var ErrorArgumentWithDash = ...

+ var ErrorConvertToFloat64 = "Argument error for option '%s': Can't convert string to float64: '%s'"

+ var ErrorConvertToInt = "Argument error for option '%s': Can't convert string to int: '%s'"

+ var ErrorMissingArgument = "Missing argument for option '%s'!"

+ var MessageOnUnknown = "Unknown option '%s'"

+ type GetOpt struct

+ Writer io.Writer

+ func New() *GetOpt

+ func (gopt *GetOpt) Bool(name string, def bool, aliases ...string) *bool

+ func (gopt *GetOpt) BoolVar(p *bool, name string, def bool, aliases ...string)

+ func (gopt *GetOpt) Called(name string) bool

+ func (gopt *GetOpt) Float64(name string, def float64, aliases ...string) *float64

+ func (gopt *GetOpt) Float64Var(p *float64, name string, def float64, aliases ...string)

+ func (gopt *GetOpt) Increment(name string, def int, aliases ...string) *int

+ func (gopt *GetOpt) IncrementVar(p *int, name string, def int, aliases ...string)

+ func (gopt *GetOpt) Int(name string, def int, aliases ...string) *int

+ func (gopt *GetOpt) IntOptional(name string, def int, aliases ...string) *int

+ func (gopt *GetOpt) IntVar(p *int, name string, def int, aliases ...string)

+ func (gopt *GetOpt) IntVarOptional(p *int, name string, def int, aliases ...string)

+ func (gopt *GetOpt) NBool(name string, def bool, aliases ...string) *bool

+ func (gopt *GetOpt) NBoolVar(p *bool, name string, def bool, aliases ...string)

+ func (gopt *GetOpt) Option(name string) interface{}

+ func (gopt *GetOpt) Parse(args []string) ([]string, error)

+ func (gopt *GetOpt) SetMode(mode string)

+ func (gopt *GetOpt) SetRequireOrder()

+ func (gopt *GetOpt) SetUnknownMode(mode string)

+ func (gopt *GetOpt) String(name, def string, aliases ...string) *string

+ func (gopt *GetOpt) StringMap(name string, aliases ...string) map[string]string

+ func (gopt *GetOpt) StringOptional(name string, def string, aliases ...string) *string

+ func (gopt *GetOpt) StringSlice(name string, aliases ...string) *[]string

+ func (gopt *GetOpt) StringSliceMulti(name string, min, max int, aliases ...string) *[]string

+ func (gopt *GetOpt) StringVar(p *string, name, def string, aliases ...string)

+ func (gopt *GetOpt) StringVarOptional(p *string, name, def string, aliases ...string)

+ func (gopt *GetOpt) Stringer() string