Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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

arguments

package

Go to main page

Versions in this module

v1

v1.2.4

Jul 1, 2025

v1.2.2

Jun 2, 2025

v1.2.1

Apr 28, 2025

v1.2.0

Apr 16, 2025

v1.1.7

Apr 11, 2025

Changes in this version

+ type Argument interface

+ Consume func(arguments []string) ([]string, error)

+ GetDefaultValue func() any

+ GetHelp func() string

+ GetLongName func() string

+ GetShortName func() string

+ GetValue func() any

+ IsPresent func() bool

+ IsRequired func() bool

+ ResetDefaultValue func()

+ SetValue func(value any)

+ type BoolArgument struct

+ DefaultValue bool

+ Help string

+ LongName string

+ Present bool

+ Required bool

+ ShortName string

+ Value *bool

+ func (arg *BoolArgument) Consume(arguments []string) ([]string, error)

+ func (arg *BoolArgument) Init(value *bool, shortName, longName string, defaultValue bool, help string)

+ func (arg *BoolArgument) ResetDefaultValue()

+ func (arg *BoolArgument) SetValue(value any)

+ func (arg BoolArgument) GetDefaultValue() any

+ func (arg BoolArgument) GetHelp() string

+ func (arg BoolArgument) GetLongName() string

+ func (arg BoolArgument) GetShortName() string

+ func (arg BoolArgument) GetValue() any

+ func (arg BoolArgument) IsPresent() bool

+ func (arg BoolArgument) IsRequired() bool

+ type IntArgument struct

+ DefaultValue int

+ Help string

+ LongName string

+ Present bool

+ Required bool

+ ShortName string

+ Value *int

+ func (arg *IntArgument) Consume(arguments []string) ([]string, error)

+ func (arg *IntArgument) Init(value *int, shortName, longName string, defaultValue int, required bool, ...)

+ func (arg *IntArgument) ResetDefaultValue()

+ func (arg *IntArgument) SetValue(value any)

+ func (arg IntArgument) GetDefaultValue() any

+ func (arg IntArgument) GetHelp() string

+ func (arg IntArgument) GetLongName() string

+ func (arg IntArgument) GetShortName() string

+ func (arg IntArgument) GetValue() any

+ func (arg IntArgument) IsPresent() bool

+ func (arg IntArgument) IsRequired() bool

+ type IntRangeArgument struct

+ DefaultValue int

+ Help string

+ LongName string

+ Present bool

+ RangeStart int

+ RangeStop int

+ Required bool

+ ShortName string

+ Value *int

+ func (arg *IntRangeArgument) Consume(arguments []string) ([]string, error)

+ func (arg *IntRangeArgument) Init(value *int, shortName, longName string, ...)

+ func (arg *IntRangeArgument) ResetDefaultValue()

+ func (arg *IntRangeArgument) SetValue(value any)

+ func (arg IntRangeArgument) GetDefaultValue() any

+ func (arg IntRangeArgument) GetHelp() string

+ func (arg IntRangeArgument) GetLongName() string

+ func (arg IntRangeArgument) GetShortName() string

+ func (arg IntRangeArgument) GetValue() any

+ func (arg IntRangeArgument) IsPresent() bool

+ func (arg IntRangeArgument) IsRequired() bool

+ type ListOfIntsArgument struct

+ DefaultValue []int

+ Help string

+ LongName string

+ Present bool

+ Required bool

+ ShortName string

+ Value *[]int

+ func (arg *ListOfIntsArgument) Consume(arguments []string) ([]string, error)

+ func (arg *ListOfIntsArgument) Init(value *[]int, shortName, longName string, defaultValue []int, required bool, ...)

+ func (arg *ListOfIntsArgument) ResetDefaultValue()

+ func (arg *ListOfIntsArgument) SetValue(value any)

+ func (arg ListOfIntsArgument) GetDefaultValue() any

+ func (arg ListOfIntsArgument) GetHelp() string

+ func (arg ListOfIntsArgument) GetLongName() string

+ func (arg ListOfIntsArgument) GetShortName() string

+ func (arg ListOfIntsArgument) GetValue() any

+ func (arg ListOfIntsArgument) IsPresent() bool

+ func (arg ListOfIntsArgument) IsRequired() bool

+ type ListOfStringsArgument struct

+ DefaultValue []string

+ Help string

+ LongName string

+ Present bool

+ Required bool

+ ShortName string

+ Value *[]string

+ func (arg *ListOfStringsArgument) Consume(arguments []string) ([]string, error)

+ func (arg *ListOfStringsArgument) Init(value *[]string, shortName, longName string, defaultValue []string, ...)

+ func (arg *ListOfStringsArgument) ResetDefaultValue()

+ func (arg *ListOfStringsArgument) SetValue(value any)

+ func (arg ListOfStringsArgument) GetDefaultValue() any

+ func (arg ListOfStringsArgument) GetHelp() string

+ func (arg ListOfStringsArgument) GetLongName() string

+ func (arg ListOfStringsArgument) GetShortName() string

+ func (arg ListOfStringsArgument) GetValue() any

+ func (arg ListOfStringsArgument) IsPresent() bool

+ func (arg ListOfStringsArgument) IsRequired() bool

+ type MapOfHttpHeadersArgument struct

+ DefaultValue map[string]string

+ Help string

+ LongName string

+ Present bool

+ Required bool

+ ShortName string

+ Value *map[string]string

+ func (arg *MapOfHttpHeadersArgument) Consume(arguments []string) ([]string, error)

+ func (arg *MapOfHttpHeadersArgument) Init(value *map[string]string, shortName, longName string, ...)

+ func (arg *MapOfHttpHeadersArgument) ResetDefaultValue()

+ func (arg *MapOfHttpHeadersArgument) SetValue(value any)

+ func (arg MapOfHttpHeadersArgument) GetDefaultValue() any

+ func (arg MapOfHttpHeadersArgument) GetHelp() string

+ func (arg MapOfHttpHeadersArgument) GetLongName() string

+ func (arg MapOfHttpHeadersArgument) GetShortName() string

+ func (arg MapOfHttpHeadersArgument) GetValue() any

+ func (arg MapOfHttpHeadersArgument) IsPresent() bool

+ func (arg MapOfHttpHeadersArgument) IsRequired() bool

+ type StringArgument struct

+ DefaultValue string

+ Help string

+ LongName string

+ Present bool

+ Required bool

+ ShortName string

+ Value *string

+ func (arg *StringArgument) Consume(arguments []string) ([]string, error)

+ func (arg *StringArgument) Init(value *string, shortName, longName string, defaultValue string, required bool, ...)

+ func (arg *StringArgument) ResetDefaultValue()

+ func (arg *StringArgument) SetValue(value any)

+ func (arg StringArgument) GetDefaultValue() any

+ func (arg StringArgument) GetHelp() string

+ func (arg StringArgument) GetLongName() string

+ func (arg StringArgument) GetShortName() string

+ func (arg StringArgument) GetValue() any

+ func (arg StringArgument) IsPresent() bool

+ func (arg StringArgument) IsRequired() bool

+ type TcpPortArgument struct

+ DefaultValue int

+ Help string

+ LongName string

+ Present bool

+ Required bool

+ ShortName string

+ Value *int

+ func (arg *TcpPortArgument) Consume(arguments []string) ([]string, error)

+ func (arg *TcpPortArgument) Init(value *int, shortName, longName string, defaultValue int, required bool, ...)

+ func (arg *TcpPortArgument) ResetDefaultValue()

+ func (arg *TcpPortArgument) SetValue(value any)

+ func (arg TcpPortArgument) GetDefaultValue() any

+ func (arg TcpPortArgument) GetHelp() string

+ func (arg TcpPortArgument) GetLongName() string

+ func (arg TcpPortArgument) GetShortName() string

+ func (arg TcpPortArgument) GetValue() any

+ func (arg TcpPortArgument) IsPresent() bool

+ func (arg TcpPortArgument) IsRequired() bool