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

config

package module

Go to main page

Versions in this module

v1

v1.12.1

Aug 15, 2018

v1.11.5

Feb 4, 2015

v1.11.4

Feb 4, 2015

v1.11.3

Feb 4, 2015

v1.11.2

Feb 4, 2015

v1.11.1

Feb 4, 2015

v1.7.7

Jan 20, 2015

v1.7.6

Jan 20, 2015

v1.7.5

Jan 20, 2015

v1.7.4

Jan 20, 2015

v1.7.3

Jan 20, 2015

v1.7.2

Jan 20, 2015

v1.7.1

Jan 20, 2015

v1.6.14

Jan 20, 2015

v1.6.13

Jan 20, 2015

v1.6.12

Jan 20, 2015

v1.6.11

Jan 20, 2015

v1.6.10

Jan 20, 2015

v1.6.9

Jan 20, 2015

v1.6.8

Jan 20, 2015

v1.6.7

Jan 9, 2015

v1.6.6

Jan 9, 2015

v1.6.5

Jan 8, 2015

v1.6.4

Jan 8, 2015

v1.6.3

Jan 8, 2015

v1.6.2

Jan 8, 2015

v1.6.1

Jan 8, 2015

Changes in this version

+ const DateFormat

+ const DateTimeFormat

+ const TimeFormat

+ var ARGS []string

+ var CONFIG_EXT = ".conf"

+ var ENV []string

+ var ErrCommandCommand = errors.New("command of command is not supported")

+ var ErrInvalidShortflag = errors.New("invalid shortflag")

+ var ErrInvalidVersion = errors.New("invalid version")

+ var ErrMissingHelp = errors.New("missing help text")

+ var GLOBAL_DIRS string

+ var NameRegExp = regexp.MustCompile("^[a-z][a-z0-9]+$")

+ var ShortflagRegexp = regexp.MustCompile("^[a-z]$")

+ var USER_DIR string

+ var VersionRegexp = regexp.MustCompile("^[a-z0-9-.]+$")

+ var WORKING_DIR string

+ func Default(val interface{}) func(*Option)

+ func Required(o *Option)

+ func Shortflag(s rune) func(*Option)

+ func ValidateName(name string) error

+ func ValidateShortflag(shortflag string) error

+ func ValidateType(option, typ string) error

+ func ValidateVersion(version string) error

+ type BoolGetter struct

+ func (b *BoolGetter) Get() bool

+ func (b *BoolGetter) IsSet() bool

+ type Config struct

+ func MustNew(app string, version string, helpIntro string) *Config

+ func New(app string, version string, helpIntro string) (c *Config, err error)

+ func (c *Config) ActiveCommand() (s *Config)

+ func (c *Config) Binary() (path string, err error)

+ func (c *Config) CheckMissing() error

+ func (c *Config) Command(name string, helpIntro string) (s *Config, err error)

+ func (c *Config) CommmandName() string

+ func (c *Config) EachSpec(fn func(name string, opt *Option))

+ func (c *Config) EachValue(fn func(name string, val interface{}))

+ func (c *Config) FirstGlobalsFile() string

+ func (c *Config) IsOption(option string) bool

+ func (c *Config) Load(withArgs bool) error

+ func (c *Config) LoadDefaults()

+ func (c *Config) LoadFile(path string) (err error, found bool)

+ func (c *Config) LoadGlobals() error

+ func (c *Config) LoadLocals() error

+ func (c *Config) LoadUser() error

+ func (c *Config) LocalFile() string

+ func (c *Config) Locations(option string) []string

+ func (c *Config) MarshalJSON() ([]byte, error)

+ func (c *Config) Merge(rd io.Reader, location string) error

+ func (c *Config) MergeArgs() error

+ func (c *Config) MergeEnv() error

+ func (c *Config) MustCommand(name string, helpIntro string) *Config

+ func (c *Config) MustNewOption(name, type_, helpText string, opts []func(*Option)) *Option

+ func (c *Config) NewBool(name, helpText string, opts ...func(*Option)) BoolGetter

+ func (c *Config) NewDate(name, helpText string, opts ...func(*Option)) DateTimeGetter

+ func (c *Config) NewDateTime(name, helpText string, opts ...func(*Option)) DateTimeGetter

+ func (c *Config) NewFloat32(name, helpText string, opts ...func(*Option)) Float32Getter

+ func (c *Config) NewInt32(name, helpText string, opts ...func(*Option)) Int32Getter

+ func (c *Config) NewJSON(name, helpText string, opts ...func(*Option)) JSONGetter

+ func (c *Config) NewOption(name, type_, helpText string, opts []func(*Option)) (*Option, error)

+ func (c *Config) NewString(name, helpText string, opts ...func(*Option)) StringGetter

+ func (c *Config) NewTime(name, helpText string, opts ...func(*Option)) DateTimeGetter

+ func (c *Config) Relax(o *Option) *Config

+ func (c *Config) Reset()

+ func (c *Config) Run() error

+ func (c *Config) SaveToGlobals() error

+ func (c *Config) SaveToLocal() error

+ func (c *Config) SaveToUser() error

+ func (c *Config) Set(option string, val string, location string) error

+ func (c *Config) SetGlobalOptions(options map[string]string) error

+ func (c *Config) SetLocalOptions(options map[string]string) error

+ func (c *Config) SetUserOptions(options map[string]string) error

+ func (c *Config) Skip(o *Option) *Config

+ func (c *Config) UnmarshalJSON(data []byte) error

+ func (c *Config) Usage() string

+ func (c *Config) UserFile() string

+ func (c *Config) ValidateValues() error

+ func (c *Config) WriteConfigFile(path string, perm os.FileMode) (err error)

+ func (c Config) GetBool(option string) bool

+ func (c Config) GetFloat32(option string) float32

+ func (c Config) GetInt32(option string) int32

+ func (c Config) GetJSON(option string, val interface{}) error

+ func (c Config) GetString(option string) string

+ func (c Config) GetTime(option string) (t time.Time)

+ func (c Config) GetValue(option string) interface{}

+ func (c Config) IsSet(option string) bool

+ type DateTimeGetter struct

+ func (b *DateTimeGetter) Get() time.Time

+ func (b *DateTimeGetter) IsSet() bool

+ type EmptyValueError string

+ func (e EmptyValueError) Error() string

+ type ErrDoubleOption string

+ func (e ErrDoubleOption) Error() string

+ type ErrDoubleShortflag string

+ func (e ErrDoubleShortflag) Error() string

+ type ErrInvalidAppName string

+ func (e ErrInvalidAppName) Error() string

+ type ErrInvalidOptionName string

+ func (e ErrInvalidOptionName) Error() string

+ type Float32Getter struct

+ func (b *Float32Getter) Get() float32

+ func (b *Float32Getter) IsSet() bool

+ type Int32Getter struct

+ func (b *Int32Getter) Get() int32

+ func (b *Int32Getter) IsSet() bool

+ type InvalidConfig struct

+ Err error

+ Version string

+ func (e InvalidConfig) Error() string

+ type InvalidConfigEnv struct

+ EnvKey string

+ Err error

+ Version string

+ func (e InvalidConfigEnv) Error() string

+ type InvalidConfigFileError struct

+ ConfigFile string

+ Err error

+ Version string

+ func (e InvalidConfigFileError) Error() string

+ type InvalidConfigFlag struct

+ Err error

+ Flag string

+ Version string

+ func (e InvalidConfigFlag) Error() string

+ type InvalidDefault struct

+ Default interface{}

+ Option string

+ Type string

+ func (e InvalidDefault) Error() string

+ type InvalidNameError string

+ func (e InvalidNameError) Error() string

+ type InvalidTypeError struct

+ Option string

+ Type string

+ func (e InvalidTypeError) Error() string

+ type InvalidValueError struct

+ Option string

+ Value interface{}

+ func (e InvalidValueError) Error() string

+ type JSONGetter struct

+ func (b *JSONGetter) Get(val interface{}) error

+ func (b *JSONGetter) IsSet() bool

+ type MissingOptionError struct

+ Option string

+ Version string

+ func (e MissingOptionError) Error() string

+ type Option struct

+ Default interface{}

+ Help string

+ Name string

+ Required bool

+ Shortflag string

+ Type string

+ func (c Option) Validate() error

+ func (c Option) ValidateDefault() error

+ func (c Option) ValidateValue(val interface{}) error

+ type StringGetter struct

+ func (b *StringGetter) Get() string

+ func (b *StringGetter) IsSet() bool

+ type UnknownOptionError struct

+ Option string

+ Version string

+ func (e UnknownOptionError) Error() string