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
- API
  
  Reference documentation for the pkg.go.dev API
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

getopt

package module

Go to main page

Versions in this module

v2

v2.2.0

Aug 23, 2026

Changes in this version

type Option

+ func CounterLongVar(p *int, name string, short rune, helpvalue ...string) Option

+ Help func() string

type Set

+ func (s *Set) CounterLongVar(p *int, name string, short rune, helpvalue ...string) Option

v2.1.0

Aug 26, 2020

Changes in this version

+ func RequiredGroup(group string)

type Option

+ Mandatory func() Option

+ SetGroup func(string) Option

type Set

+ func (s *Set) RequiredGroup(group string)

v2.0.0

Aug 16, 2020

Changes in this version

+ const Dash

+ const DashDash

+ const EndOfArguments

+ const EndOfOptions

+ const ExtraParameter

+ const Failure

+ const InProgress

+ const Invalid

+ const MissingParameter

+ const NoError

+ const Terminated

+ const Unknown

+ const UnknownOption

+ var CommandLine = New()

+ var DisplayWidth = 80

+ var HelpColumn = 20

+ func AddOption(o Option)

+ func Arg(n int) string

+ func Args() []string

+ func Bool(name rune, helpvalue ...string) *bool

+ func BoolLong(name string, short rune, helpvalue ...string) *bool

+ func Counter(name rune, helpvalue ...string) *int

+ func CounterLong(name string, short rune, helpvalue ...string) *int

+ func Duration(name rune, value time.Duration, helpvalue ...string) *time.Duration

+ func DurationLong(name string, short rune, value time.Duration, helpvalue ...string) *time.Duration

+ func Enum(name rune, values []string, value string, helpvalue ...string) *string

+ func EnumLong(name string, short rune, values []string, value string, helpvalue ...string) *string

+ func GetCount(name interface{}) int

+ func GetValue(name interface{}) string

+ func Getopt(fn func(Option) bool) error

+ func Int(name rune, value int, helpvalue ...string) *int

+ func Int16(name rune, value int16, helpvalue ...string) *int16

+ func Int16Long(name string, short rune, value int16, helpvalue ...string) *int16

+ func Int32(name rune, value int32, helpvalue ...string) *int32

+ func Int32Long(name string, short rune, value int32, helpvalue ...string) *int32

+ func Int64(name rune, value int64, helpvalue ...string) *int64

+ func Int64Long(name string, short rune, value int64, helpvalue ...string) *int64

+ func IntLong(name string, short rune, value int, helpvalue ...string) *int

+ func IsSet(name interface{}) bool

+ func List(name rune, helpvalue ...string) *[]string

+ func ListLong(name string, short rune, helpvalue ...string) *[]string

+ func NArgs() int

+ func Parse()

+ func ParseV2()

+ func PrintUsage(w io.Writer)

+ func Reset()

+ func SetParameters(parameters string)

+ func SetProgram(program string)

+ func SetUsage(usage func())

+ func Signed(name rune, value int64, l *SignedLimit, helpvalue ...string) *int64

+ func SignedLong(name string, short rune, value int64, l *SignedLimit, helpvalue ...string) *int64

+ func String(name rune, value string, helpvalue ...string) *string

+ func StringLong(name string, short rune, value string, helpvalue ...string) *string

+ func Uint(name rune, value uint, helpvalue ...string) *uint

+ func Uint16(name rune, value uint16, helpvalue ...string) *uint16

+ func Uint16Long(name string, short rune, value uint16, helpvalue ...string) *uint16

+ func Uint32(name rune, value uint32, helpvalue ...string) *uint32

+ func Uint32Long(name string, short rune, value uint32, helpvalue ...string) *uint32

+ func Uint64(name rune, value uint64, helpvalue ...string) *uint64

+ func Uint64Long(name string, short rune, value uint64, helpvalue ...string) *uint64

+ func UintLong(name string, short rune, value uint, helpvalue ...string) *uint

+ func Unsigned(name rune, value uint64, l *UnsignedLimit, helpvalue ...string) *uint64

+ func UnsignedLong(name string, short rune, value uint64, l *UnsignedLimit, helpvalue ...string) *uint64

+ func Usage()

+ func Visit(fn func(Option))

+ func VisitAll(fn func(Option))

+ type Error struct

+ Err error

+ Name string

+ Parameter string

+ func (i *Error) Error() string

+ type ErrorCode int

+ func (e ErrorCode) String() string

+ type Option interface

+ Count func() int

+ IsFlag func() bool

+ LongName func() string

+ Name func() string

+ Reset func()

+ Seen func() bool

+ SetFlag func() Option

+ SetOptional func() Option

+ ShortName func() string

+ String func() string

+ Value func() Value

+ func Flag(v interface{}, short rune, helpvalue ...string) Option

+ func FlagLong(v interface{}, long string, short rune, helpvalue ...string) Option

+ func Lookup(name interface{}) Option

+ type Set struct

+ func New() *Set

+ func (s *Set) AddOption(o Option)

+ func (s *Set) Arg(n int) string

+ func (s *Set) Args() []string

+ func (s *Set) Bool(name rune, helpvalue ...string) *bool

+ func (s *Set) BoolLong(name string, short rune, helpvalue ...string) *bool

+ func (s *Set) Counter(name rune, helpvalue ...string) *int

+ func (s *Set) CounterLong(name string, short rune, helpvalue ...string) *int

+ func (s *Set) Duration(name rune, value time.Duration, helpvalue ...string) *time.Duration

+ func (s *Set) DurationLong(name string, short rune, value time.Duration, helpvalue ...string) *time.Duration

+ func (s *Set) Enum(name rune, values []string, value string, helpvalue ...string) *string

+ func (s *Set) EnumLong(name string, short rune, values []string, value string, helpvalue ...string) *string

+ func (s *Set) Flag(v interface{}, short rune, helpvalue ...string) Option

+ func (s *Set) FlagLong(v interface{}, long string, short rune, helpvalue ...string) Option

+ func (s *Set) GetCount(name interface{}) int

+ func (s *Set) GetValue(name interface{}) string

+ func (s *Set) Getopt(args []string, fn func(Option) bool) (err error)

+ func (s *Set) Int(name rune, value int, helpvalue ...string) *int

+ func (s *Set) Int16(name rune, value int16, helpvalue ...string) *int16

+ func (s *Set) Int16Long(name string, short rune, value int16, helpvalue ...string) *int16

+ func (s *Set) Int32(name rune, value int32, helpvalue ...string) *int32

+ func (s *Set) Int32Long(name string, short rune, value int32, helpvalue ...string) *int32

+ func (s *Set) Int64(name rune, value int64, helpvalue ...string) *int64

+ func (s *Set) Int64Long(name string, short rune, value int64, helpvalue ...string) *int64

+ func (s *Set) IntLong(name string, short rune, value int, helpvalue ...string) *int

+ func (s *Set) IsSet(name interface{}) bool

+ func (s *Set) List(name rune, helpvalue ...string) *[]string

+ func (s *Set) ListLong(name string, short rune, helpvalue ...string) *[]string

+ func (s *Set) Lookup(name interface{}) Option

+ func (s *Set) NArgs() int

+ func (s *Set) Parameters() string

+ func (s *Set) Parse(args []string)

+ func (s *Set) PrintOptions(w io.Writer)

+ func (s *Set) PrintUsage(w io.Writer)

+ func (s *Set) Program() string

+ func (s *Set) Reset()

+ func (s *Set) SetParameters(parameters string)

+ func (s *Set) SetProgram(program string)

+ func (s *Set) SetUsage(usage func())

+ func (s *Set) Signed(name rune, value int64, l *SignedLimit, helpvalue ...string) *int64

+ func (s *Set) SignedLong(name string, short rune, value int64, l *SignedLimit, helpvalue ...string) *int64

+ func (s *Set) State() State

+ func (s *Set) String(name rune, value string, helpvalue ...string) *string

+ func (s *Set) StringLong(name string, short rune, value string, helpvalue ...string) *string

+ func (s *Set) Uint(name rune, value uint, helpvalue ...string) *uint

+ func (s *Set) Uint16(name rune, value uint16, helpvalue ...string) *uint16

+ func (s *Set) Uint16Long(name string, short rune, value uint16, helpvalue ...string) *uint16

+ func (s *Set) Uint32(name rune, value uint32, helpvalue ...string) *uint32

+ func (s *Set) Uint32Long(name string, short rune, value uint32, helpvalue ...string) *uint32

+ func (s *Set) Uint64(name rune, value uint64, helpvalue ...string) *uint64

+ func (s *Set) Uint64Long(name string, short rune, value uint64, helpvalue ...string) *uint64

+ func (s *Set) UintLong(name string, short rune, value uint, helpvalue ...string) *uint

+ func (s *Set) Unsigned(name rune, value uint64, l *UnsignedLimit, helpvalue ...string) *uint64

+ func (s *Set) UnsignedLong(name string, short rune, value uint64, l *UnsignedLimit, helpvalue ...string) *uint64

+ func (s *Set) UsageLine() string

+ func (s *Set) Visit(fn func(Option))

+ func (s *Set) VisitAll(fn func(Option))

+ type SignedLimit struct

+ Base int

+ Bits int

+ Max int64

+ Min int64

+ type State int

+ type UnsignedLimit struct

+ Base int

+ Bits int

+ Max uint64

+ Min uint64

+ type Value interface

+ Set func(value string, opt Option) error

+ String func() string

Other modules containing this package

github.com/pborman/getopt