Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

flagsplugin

package

Go to main page

Versions in this module

v1

v1.2.0

Aug 8, 2023

v1.2.0-rc.1

Aug 4, 2023

v1.1.0

Apr 3, 2023

v1.0.6

Nov 7, 2022

v1.0.5

Sep 7, 2022

v1.0.4

Sep 7, 2022

v1.0.3

May 25, 2022

v1.0.2

May 13, 2022

v1.0.1

May 5, 2022

v1.0.0

Apr 21, 2022

Changes in this version

+ var Base64Replacer = strings.NewReplacer("_", "/", "-", "+")

+ func AddAlias(flagSet *pflag.FlagSet, flagName, aliasName string, opts ...FlagOption)

+ func ApplyOptions(f *pflag.Flag, opts ...FlagOption)

+ func EnumValueDesc(valueMaps ...map[string]int32) string

+ func GetBool(fs *pflag.FlagSet, name string) (value bool, set bool, err error)

+ func GetBoolSlice(fs *pflag.FlagSet, name string) (value []bool, set bool, err error)

+ func GetBytes(fs *pflag.FlagSet, name string) (value []byte, set bool, err error)

+ func GetBytesSlice(fs *pflag.FlagSet, name string) (value [][]byte, set bool, err error)

+ func GetDuration(fs *pflag.FlagSet, name string) (value time.Duration, set bool, err error)

+ func GetDurationSlice(fs *pflag.FlagSet, name string) (value []time.Duration, set bool, err error)

+ func GetFloat32(fs *pflag.FlagSet, name string) (value float32, set bool, err error)

+ func GetFloat32Slice(fs *pflag.FlagSet, name string) (value []float32, set bool, err error)

+ func GetFloat64(fs *pflag.FlagSet, name string) (value float64, set bool, err error)

+ func GetFloat64Slice(fs *pflag.FlagSet, name string) (value []float64, set bool, err error)

+ func GetInt32(fs *pflag.FlagSet, name string) (value int32, set bool, err error)

+ func GetInt32Slice(fs *pflag.FlagSet, name string) (value []int32, set bool, err error)

+ func GetInt64(fs *pflag.FlagSet, name string) (value int64, set bool, err error)

+ func GetInt64Slice(fs *pflag.FlagSet, name string) (value []int64, set bool, err error)

+ func GetString(fs *pflag.FlagSet, name string) (value string, set bool, err error)

+ func GetStringBoolMap(fs *pflag.FlagSet, name string) (value map[string]bool, set bool, err error)

+ func GetStringBytesMap(fs *pflag.FlagSet, name string) (value map[string][]byte, set bool, err error)

+ func GetStringDurationMap(fs *pflag.FlagSet, name string) (value map[string]time.Duration, set bool, err error)

+ func GetStringFloat32Map(fs *pflag.FlagSet, name string) (value map[string]float32, set bool, err error)

+ func GetStringFloat64Map(fs *pflag.FlagSet, name string) (value map[string]float64, set bool, err error)

+ func GetStringInt32Map(fs *pflag.FlagSet, name string) (value map[string]int32, set bool, err error)

+ func GetStringInt64Map(fs *pflag.FlagSet, name string) (value map[string]int64, set bool, err error)

+ func GetStringSlice(fs *pflag.FlagSet, name string) (value []string, set bool, err error)

+ func GetStringStringMap(fs *pflag.FlagSet, name string) (value map[string]string, set bool, err error)

+ func GetStringTimestampMap(fs *pflag.FlagSet, name string) (value map[string]time.Time, set bool, err error)

+ func GetStringUint32Map(fs *pflag.FlagSet, name string) (value map[string]uint32, set bool, err error)

+ func GetStringUint64Map(fs *pflag.FlagSet, name string) (value map[string]uint64, set bool, err error)

+ func GetTimestamp(fs *pflag.FlagSet, name string) (value time.Time, set bool, err error)

+ func GetTimestampSlice(fs *pflag.FlagSet, name string) (value []time.Time, set bool, err error)

+ func GetUint32(fs *pflag.FlagSet, name string) (value uint32, set bool, err error)

+ func GetUint32Slice(fs *pflag.FlagSet, name string) (value []uint32, set bool, err error)

+ func GetUint64(fs *pflag.FlagSet, name string) (value uint64, set bool, err error)

+ func GetUint64Slice(fs *pflag.FlagSet, name string) (value []uint64, set bool, err error)

+ func IsAnyPrefixSet(fs *pflag.FlagSet, prefix string) (flagSet bool)

+ func JoinSliceElements(elements []string) string

+ func NewBase64BytesFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewBase64BytesSliceFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewBoolFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewBoolSliceFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewBytesFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewBytesSliceFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewDurationFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewDurationSliceFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewFloat32Flag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewFloat32SliceFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewFloat64Flag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewFloat64SliceFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewHexBytesFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewHexBytesSliceFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewInt32Flag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewInt32SliceFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewInt64Flag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewInt64SliceFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewStringBase64BytesMapFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewStringBoolMapFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewStringBytesMapFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewStringDurationMapFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewStringFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewStringFloat32MapFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewStringFloat64MapFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewStringHexBytesMapFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewStringInt32MapFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewStringInt64MapFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewStringSliceFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewStringStringMapFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewStringTimestampMapFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewStringUint32MapFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewStringUint64MapFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewTimestampFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewTimestampSliceFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewUint32Flag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewUint32SliceFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewUint64Flag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func NewUint64SliceFlag(name, usage string, opts ...FlagOption) *pflag.Flag

+ func Prefix(field, prefix string) string

+ func SelectDesc(fieldName string, withSubFields bool) string

+ func SetEnumString(v string, valueMaps ...map[string]int32) (int32, error)

+ func SplitSliceElements(s string) ([]string, error)

+ type AliasValue struct

+ func (av *AliasValue) Set(s string) error

+ func (av *AliasValue) String() string

+ func (av *AliasValue) Type() string

+ type BoolSliceValue struct

+ Values []BoolValue

+ func (*BoolSliceValue) Type() string

+ func (bsv *BoolSliceValue) Set(s string) error

+ func (bsv *BoolSliceValue) String() string

+ type BoolValue struct

+ Value bool

+ func (*BoolValue) Type() string

+ func (bv *BoolValue) Set(s string) error

+ func (bv *BoolValue) String() string

+ type BytesSliceValue struct

+ Encoding string

+ Values []BytesValue

+ func (bsv *BytesSliceValue) Set(s string) error

+ func (bsv *BytesSliceValue) String() string

+ func (bsv *BytesSliceValue) Type() string

+ type BytesValue struct

+ Encoding string

+ Value []byte

+ func (bv *BytesValue) Set(s string) error

+ func (bv *BytesValue) String() string

+ func (bv *BytesValue) Type() string

+ type DurationSliceValue struct

+ Values []DurationValue

+ func (*DurationSliceValue) Type() string

+ func (dsv *DurationSliceValue) Set(s string) error

+ func (dsv *DurationSliceValue) String() string

+ type DurationValue struct

+ Value time.Duration

+ func (*DurationValue) Type() string

+ func (dv *DurationValue) Set(s string) error

+ func (dv *DurationValue) String() string

+ type ErrFlagNotFound struct

+ FlagName string

+ func (err *ErrFlagNotFound) Error() string

+ type FlagOption func(*pflag.Flag)

+ func WithHidden(hidden bool) FlagOption

+ type Float32SliceValue struct

+ Values []Float32Value

+ func (*Float32SliceValue) Type() string

+ func (fsv *Float32SliceValue) Set(s string) error

+ func (fsv *Float32SliceValue) String() string

+ type Float32Value struct

+ Value float32

+ func (*Float32Value) Type() string

+ func (fv *Float32Value) Set(s string) error

+ func (fv *Float32Value) String() string

+ type Float64SliceValue struct

+ Values []Float64Value

+ func (*Float64SliceValue) Type() string

+ func (fsv *Float64SliceValue) Set(s string) error

+ func (fsv *Float64SliceValue) String() string

+ type Float64Value struct

+ Value float64

+ func (*Float64Value) Type() string

+ func (fv *Float64Value) Set(s string) error

+ func (fv *Float64Value) String() string

+ type Int32SliceValue struct

+ Values []Int32Value

+ func (*Int32SliceValue) Type() string

+ func (isv *Int32SliceValue) Set(s string) error

+ func (isv *Int32SliceValue) String() string

+ type Int32Value struct

+ Value int32

+ func (*Int32Value) Type() string

+ func (iv *Int32Value) Set(s string) error

+ func (iv *Int32Value) String() string

+ type Int64SliceValue struct

+ Values []Int64Value

+ func (*Int64SliceValue) Type() string

+ func (isv *Int64SliceValue) Set(s string) error

+ func (isv *Int64SliceValue) String() string

+ type Int64Value struct

+ Value int64

+ func (*Int64Value) Type() string

+ func (iv *Int64Value) Set(s string) error

+ func (iv *Int64Value) String() string

+ type SetterFromFlags interface

+ SetFromFlags func(flags *pflag.FlagSet, prefix string) (paths []string, err error)

+ type StringBoolMapValue struct

+ Values map[string]BoolValue

+ func (*StringBoolMapValue) Type() string

+ func (sbmv *StringBoolMapValue) Set(s string) error

+ func (sbmv *StringBoolMapValue) String() string

+ type StringBytesMapValue struct

+ Encoding string

+ Values map[string]BytesValue

+ func (sbmv *StringBytesMapValue) Set(s string) error

+ func (sbmv *StringBytesMapValue) String() string

+ func (sbmv *StringBytesMapValue) Type() string

+ type StringDurationMapValue struct

+ Values map[string]DurationValue

+ func (*StringDurationMapValue) Type() string

+ func (sdmv *StringDurationMapValue) Set(s string) error

+ func (sdmv *StringDurationMapValue) String() string

+ type StringFloat32MapValue struct

+ Values map[string]Float32Value

+ func (*StringFloat32MapValue) Type() string

+ func (sfmv *StringFloat32MapValue) Set(s string) error

+ func (sfmv *StringFloat32MapValue) String() string

+ type StringFloat64MapValue struct

+ Values map[string]Float64Value

+ func (*StringFloat64MapValue) Type() string

+ func (sfmv *StringFloat64MapValue) Set(s string) error

+ func (sfmv *StringFloat64MapValue) String() string

+ type StringInt32MapValue struct

+ Values map[string]Int32Value

+ func (*StringInt32MapValue) Type() string

+ func (simv *StringInt32MapValue) Set(s string) error

+ func (simv *StringInt32MapValue) String() string

+ type StringInt64MapValue struct

+ Values map[string]Int64Value

+ func (*StringInt64MapValue) Type() string

+ func (simv *StringInt64MapValue) Set(s string) error

+ func (simv *StringInt64MapValue) String() string

+ type StringSliceValue struct

+ Values []StringValue

+ func (*StringSliceValue) Type() string

+ func (ssv *StringSliceValue) Set(s string) error

+ func (ssv *StringSliceValue) String() string

+ type StringStringMapValue struct

+ Values map[string]StringValue

+ func (*StringStringMapValue) Type() string

+ func (ssmv *StringStringMapValue) Set(s string) error

+ func (ssmv *StringStringMapValue) String() string

+ type StringTimestampMapValue struct

+ Values map[string]TimestampValue

+ func (*StringTimestampMapValue) Type() string

+ func (stmv *StringTimestampMapValue) Set(s string) error

+ func (stmv *StringTimestampMapValue) String() string

+ type StringUint32MapValue struct

+ Values map[string]Uint32Value

+ func (*StringUint32MapValue) Type() string

+ func (sumv *StringUint32MapValue) Set(s string) error

+ func (sumv *StringUint32MapValue) String() string

+ type StringUint64MapValue struct

+ Values map[string]Uint64Value

+ func (*StringUint64MapValue) Type() string

+ func (sumv *StringUint64MapValue) Set(s string) error

+ func (sumv *StringUint64MapValue) String() string

+ type StringValue struct

+ Value string

+ func (*StringValue) Type() string

+ func (sv *StringValue) Set(s string) error

+ func (sv *StringValue) String() string

+ type TimestampSliceValue struct

+ Values []TimestampValue

+ func (*TimestampSliceValue) Type() string

+ func (tsv *TimestampSliceValue) Set(s string) error

+ func (tsv *TimestampSliceValue) String() string

+ type TimestampValue struct

+ Value time.Time

+ func (*TimestampValue) Type() string

+ func (tv *TimestampValue) Set(s string) error

+ func (tv *TimestampValue) String() string

+ type Uint32SliceValue struct

+ Values []Uint32Value

+ func (*Uint32SliceValue) Type() string

+ func (usv *Uint32SliceValue) Set(s string) error

+ func (usv *Uint32SliceValue) String() string

+ type Uint32Value struct

+ Value uint32

+ func (*Uint32Value) Type() string

+ func (uv *Uint32Value) Set(s string) error

+ func (uv *Uint32Value) String() string

+ type Uint64SliceValue struct

+ Values []Uint64Value

+ func (*Uint64SliceValue) Type() string

+ func (usv *Uint64SliceValue) Set(s string) error

+ func (usv *Uint64SliceValue) String() string

+ type Uint64Value struct

+ Value uint64

+ func (*Uint64Value) Type() string

+ func (uv *Uint64Value) Set(s string) error

+ func (uv *Uint64Value) String() string