Help us shape the future of Go! Take the 2026 Go Developer Survey

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

viper

package module

Go to main page

Versions in this module

v1

v1.1.0

Aug 3, 2018

Changes in this version

+ func GetInt32(key string) int32

+ type DecoderConfigOption func(*mapstructure.DecoderConfig)

+ func DecodeHook(hook mapstructure.DecodeHookFunc) DecoderConfigOption

type Viper

+ func (v *Viper) GetInt32(key string) int32

v1.0.2

Mar 19, 2018

v1.0.1

Mar 19, 2018

Changes in this version

+ func SafeWriteConfig() error

+ func SafeWriteConfigAs(filename string) error

+ func WriteConfig() error

+ func WriteConfigAs(filename string) error

+ type ConfigMarshalError struct

+ func (e ConfigMarshalError) Error() string

type Viper

+ func (v *Viper) GetConfigFile() (string, error)

+ func (v *Viper) SafeWriteConfig() error

+ func (v *Viper) SafeWriteConfigAs(filename string) error

+ func (v *Viper) WriteConfig() error

+ func (v *Viper) WriteConfigAs(filename string) error

v1.0.0

Jul 23, 2017

Changes in this version

+ var RemoteConfig remoteConfigFactory

+ var SupportedExts = []string

+ var SupportedRemoteProviders = []string

+ func AddConfigPath(in string)

+ func AddRemoteProvider(provider, endpoint, path string) error

+ func AddSecureRemoteProvider(provider, endpoint, path, secretkeyring string) error

+ func AllKeys() []string

+ func AllSettings() map[string]interface

+ func AutomaticEnv()

+ func BindEnv(input ...string) error

+ func BindFlagValue(key string, flag FlagValue) error

+ func BindFlagValues(flags FlagValueSet) error

+ func BindPFlag(key string, flag *pflag.Flag) error

+ func BindPFlags(flags *pflag.FlagSet) error

+ func ConfigFileUsed() string

+ func Debug()

+ func Get(key string) interface

+ func GetBool(key string) bool

+ func GetDuration(key string) time.Duration

+ func GetFloat64(key string) float64

+ func GetInt(key string) int

+ func GetInt64(key string) int64

+ func GetSizeInBytes(key string) uint

+ func GetString(key string) string

+ func GetStringMap(key string) map[string]interface

+ func GetStringMapString(key string) map[string]string

+ func GetStringMapStringSlice(key string) map[string][]string

+ func GetStringSlice(key string) []string

+ func GetTime(key string) time.Time

+ func InConfig(key string) bool

+ func IsSet(key string) bool

+ func MergeConfig(in io.Reader) error

+ func MergeInConfig() error

+ func OnConfigChange(run func(in fsnotify.Event))

+ func ReadConfig(in io.Reader) error

+ func ReadInConfig() error

+ func ReadRemoteConfig() error

+ func RegisterAlias(alias string, key string)

+ func Reset()

+ func Set(key string, value interface{})

+ func SetConfigFile(in string)

+ func SetConfigName(in string)

+ func SetConfigType(in string)

+ func SetDefault(key string, value interface{})

+ func SetEnvKeyReplacer(r *strings.Replacer)

+ func SetEnvPrefix(in string)

+ func SetFs(fs afero.Fs)

+ func SetTypeByDefaultValue(enable bool)

+ func Unmarshal(rawVal interface{}) error

+ func UnmarshalKey(key string, rawVal interface{}) error

+ func WatchConfig()

+ func WatchRemoteConfig() error

+ type ConfigFileNotFoundError struct

+ func (fnfe ConfigFileNotFoundError) Error() string

+ type ConfigParseError struct

+ func (pe ConfigParseError) Error() string

+ type FlagValue interface

+ HasChanged func() bool

+ Name func() string

+ ValueString func() string

+ ValueType func() string

+ type FlagValueSet interface

+ VisitAll func(fn func(FlagValue))

+ type RemoteConfigError string

+ func (rce RemoteConfigError) Error() string

+ type RemoteProvider interface

+ Endpoint func() string

+ Path func() string

+ Provider func() string

+ SecretKeyring func() string

+ type RemoteResponse struct

+ Error error

+ Value []byte

+ type UnsupportedConfigError string

+ func (str UnsupportedConfigError) Error() string

+ type UnsupportedRemoteProviderError string

+ func (str UnsupportedRemoteProviderError) Error() string

+ type Viper struct

+ func GetViper() *Viper

+ func New() *Viper

+ func Sub(key string) *Viper

+ func (v *Viper) AddConfigPath(in string)

+ func (v *Viper) AddRemoteProvider(provider, endpoint, path string) error

+ func (v *Viper) AddSecureRemoteProvider(provider, endpoint, path, secretkeyring string) error

+ func (v *Viper) AllKeys() []string

+ func (v *Viper) AllSettings() map[string]interface{}

+ func (v *Viper) AutomaticEnv()

+ func (v *Viper) BindEnv(input ...string) error

+ func (v *Viper) BindFlagValue(key string, flag FlagValue) error

+ func (v *Viper) BindFlagValues(flags FlagValueSet) (err error)

+ func (v *Viper) BindPFlag(key string, flag *pflag.Flag) error

+ func (v *Viper) BindPFlags(flags *pflag.FlagSet) error

+ func (v *Viper) ConfigFileUsed() string

+ func (v *Viper) Debug()

+ func (v *Viper) Get(key string) interface{}

+ func (v *Viper) GetBool(key string) bool

+ func (v *Viper) GetDuration(key string) time.Duration

+ func (v *Viper) GetFloat64(key string) float64

+ func (v *Viper) GetInt(key string) int

+ func (v *Viper) GetInt64(key string) int64

+ func (v *Viper) GetSizeInBytes(key string) uint

+ func (v *Viper) GetString(key string) string

+ func (v *Viper) GetStringMap(key string) map[string]interface{}

+ func (v *Viper) GetStringMapString(key string) map[string]string

+ func (v *Viper) GetStringMapStringSlice(key string) map[string][]string

+ func (v *Viper) GetStringSlice(key string) []string

+ func (v *Viper) GetTime(key string) time.Time

+ func (v *Viper) InConfig(key string) bool

+ func (v *Viper) IsSet(key string) bool

+ func (v *Viper) MergeConfig(in io.Reader) error

+ func (v *Viper) MergeInConfig() error

+ func (v *Viper) OnConfigChange(run func(in fsnotify.Event))

+ func (v *Viper) ReadConfig(in io.Reader) error

+ func (v *Viper) ReadInConfig() error

+ func (v *Viper) ReadRemoteConfig() error

+ func (v *Viper) RegisterAlias(alias string, key string)

+ func (v *Viper) Set(key string, value interface{})

+ func (v *Viper) SetConfigFile(in string)

+ func (v *Viper) SetConfigName(in string)

+ func (v *Viper) SetConfigType(in string)

+ func (v *Viper) SetDefault(key string, value interface{})

+ func (v *Viper) SetEnvKeyReplacer(r *strings.Replacer)

+ func (v *Viper) SetEnvPrefix(in string)

+ func (v *Viper) SetFs(fs afero.Fs)

+ func (v *Viper) SetTypeByDefaultValue(enable bool)

+ func (v *Viper) Sub(key string) *Viper

+ func (v *Viper) Unmarshal(rawVal interface{}) error

+ func (v *Viper) UnmarshalExact(rawVal interface{}) error

+ func (v *Viper) UnmarshalKey(key string, rawVal interface{}) error

+ func (v *Viper) WatchConfig()

+ func (v *Viper) WatchRemoteConfig() error

+ func (v *Viper) WatchRemoteConfigOnChannel() error