goflags

README

goflags

A wrapper on go flag library adding some convenience wrappers like better Usage, short and long flags, config file support, etc.

Thanks

1. spf13/cobra - The very nice usage template for the command line.

Documentation

Index

• func ToStringSlice(value string) ([]string, error)
• type FlagData
  • func (flagData *FlagData) Group(name string)
  • func (flagData *FlagData) Hash() string
• type FlagSet
  • func NewFlagSet() *FlagSet
  • func (flagSet *FlagSet) BoolVar(field *bool, long string, defaultValue bool, usage string) *FlagData
  • func (flagSet *FlagSet) BoolVarP(field *bool, long, short string, defaultValue bool, usage string) *FlagData
  • func (flagSet *FlagSet) IntVar(field *int, long string, defaultValue int, usage string) *FlagData
  • func (flagSet *FlagSet) IntVarP(field *int, long, short string, defaultValue int, usage string) *FlagData
  • func (flagSet *FlagSet) MergeConfigFile(file string) error
  • func (flagSet *FlagSet) Parse() error
  • func (flagSet *FlagSet) SetDescription(description string)
  • func (flagSet *FlagSet) SetGroup(name, description string)
  • func (flagSet *FlagSet) StringSliceVar(field *StringSlice, long string, defaultValue []string, usage string) *FlagData
  • func (flagSet *FlagSet) StringSliceVarP(field *StringSlice, long, short string, defaultValue []string, usage string) *FlagData
  • func (flagSet *FlagSet) StringVar(field *string, long, defaultValue, usage string) *FlagData
  • func (flagSet *FlagSet) StringVarEnv(field *string, long, short, defaultValue, envName, usage string) *FlagData
  • func (flagSet *FlagSet) StringVarP(field *string, long, short, defaultValue, usage string) *FlagData
  • func (flagSet *FlagSet) Var(field flag.Value, long, usage string) *FlagData
  • func (flagSet *FlagSet) VarP(field flag.Value, long, short, usage string) *FlagData
• type InsertionOrderedMap
  • func (insertionOrderedMap *InsertionOrderedMap) Set(key string, value *FlagData)
• type StringSlice
  • func (stringSlice *StringSlice) Set(value string) error
  • func (stringSlice *StringSlice) String() string

Functions

func ToStringSlice

func ToStringSlice(value string) ([]string, error)

Types

type FlagData

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

func (*FlagData) Group

func (flagData *FlagData) Group(name string)

Group sets the group for a flag data

func (*FlagData) Hash

func (flagData *FlagData) Hash() string

Hash returns the unique hash for a flagData structure NOTE: Hash panics when the structure cannot be hashed.

type FlagSet

type FlagSet struct {
	Marshal bool

	// OtherOptionsGroupName is the name for all flags not in a group
	OtherOptionsGroupName string
	// contains filtered or unexported fields
}

FlagSet is a list of flags for an application

func NewFlagSet

func NewFlagSet() *FlagSet

NewFlagSet creates a new flagSet structure for the application

func (*FlagSet) BoolVar

func (flagSet *FlagSet) BoolVar(field *bool, long string, defaultValue bool, usage string) *FlagData

BoolVar adds a bool flag with a longname

func (*FlagSet) BoolVarP

func (flagSet *FlagSet) BoolVarP(field *bool, long, short string, defaultValue bool, usage string) *FlagData

BoolVarP adds a bool flag with a shortname and longname

func (*FlagSet) IntVar

func (flagSet *FlagSet) IntVar(field *int, long string, defaultValue int, usage string) *FlagData

IntVar adds a int flag with a longname

func (*FlagSet) IntVarP

func (flagSet *FlagSet) IntVarP(field *int, long, short string, defaultValue int, usage string) *FlagData

IntVarP adds a int flag with a shortname and longname

func (*FlagSet) MergeConfigFile

func (flagSet *FlagSet) MergeConfigFile(file string) error

MergeConfigFile reads a config file to merge values from.

func (*FlagSet) Parse

func (flagSet *FlagSet) Parse() error

Parse parses the flags provided to the library.

func (*FlagSet) SetDescription

func (flagSet *FlagSet) SetDescription(description string)

SetDescription sets the description field for a flagSet to a value.

func (*FlagSet) SetGroup

func (flagSet *FlagSet) SetGroup(name, description string)

SetGroup sets a group with name and description for the command line options

The order in which groups are passed is also kept as is, similar to flags.

func (*FlagSet) StringSliceVar

func (flagSet *FlagSet) StringSliceVar(field *StringSlice, long string, defaultValue []string, usage string) *FlagData

StringSliceVar adds a string slice flag with a longname

func (*FlagSet) StringSliceVarP

func (flagSet *FlagSet) StringSliceVarP(field *StringSlice, long, short string, defaultValue []string, usage string) *FlagData

StringSliceVarP adds a string slice flag with a shortname and longname

func (*FlagSet) StringVar

func (flagSet *FlagSet) StringVar(field *string, long, defaultValue, usage string) *FlagData

StringVar adds a string flag with a longname

func (*FlagSet) StringVarEnv

func (flagSet *FlagSet) StringVarEnv(field *string, long, short, defaultValue, envName, usage string) *FlagData

StringVarEnv adds a string flag with a shortname and longname with a default value read from env variable with a default value fallback

func (*FlagSet) StringVarP

func (flagSet *FlagSet) StringVarP(field *string, long, short, defaultValue, usage string) *FlagData

StringVarP adds a string flag with a shortname and longname

func (*FlagSet) Var

func (flagSet *FlagSet) Var(field flag.Value, long, usage string) *FlagData

Var adds a Var flag with a longname

func (*FlagSet) VarP

func (flagSet *FlagSet) VarP(field flag.Value, long, short, usage string) *FlagData

VarP adds a Var flag with a shortname and longname

type InsertionOrderedMap

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

func (*InsertionOrderedMap) Set

func (insertionOrderedMap *InsertionOrderedMap) Set(key string, value *FlagData)

type StringSlice

type StringSlice []string

StringSlice is a slice of strings

func (*StringSlice) Set

func (stringSlice *StringSlice) Set(value string) error

Set appends a value to the string slice.

func (*StringSlice) String

func (stringSlice *StringSlice) String() string