https://github.com/uber-go/config
Configuration for Go applications
https://github.com/uber-go/config
configuration go golang yaml
Last synced: 2 months ago
JSON representation
Configuration for Go applications
- Host: GitHub
- URL: https://github.com/uber-go/config
- Owner: uber-go
- License: mit
- Created: 2017-05-23T17:45:52.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-05T19:13:39.000Z (over 1 year ago)
- Last Synced: 2025-04-12T00:55:56.849Z (2 months ago)
- Topics: configuration, go, golang, yaml
- Language: Go
- Homepage: https://godoc.org/go.uber.org/config
- Size: 345 KB
- Stars: 462
- Watchers: 14
- Forks: 42
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# :fishing_pole_and_fish: config [![GoDoc][doc-img]][doc] [![Build Status][ci-img]][ci] [![Coverage Status][cov-img]][cov]
Convenient, injection-friendly YAML configuration.
## Installation
```
go get -u go.uber.org/config
```
Note that config only supports the two most recent minor versions of Go.
## Quick Start
```golang
// Model your application's configuration using a Go struct.
type cfg struct {
Parameter string
}
// Two sources of configuration to merge.
base := strings.NewReader("module: {parameter: foo}")
override := strings.NewReader("module: {parameter: bar}")
// Merge the two sources into a Provider. Later sources are higher-priority.
// See the top-level package documentation for details on the merging logic.
provider, err := config.NewYAML(config.Source(base), config.Source(override))
if err != nil {
panic(err) // handle error
}
var c cfg
if err := provider.Get("module").Populate(&c); err != nil {
panic(err) // handle error
}
fmt.Printf("%+v\n", c)
// Output:
// {Parameter:bar}
```
## Development Status: Stable
All APIs are finalized, and no breaking changes will be made in the 1.x series
of releases. Users of semver-aware dependency management systems should pin
config to `^1`.
---
Released under the [MIT License](LICENSE.txt).
[doc-img]: http://img.shields.io/badge/GoDoc-Reference-blue.svg
[doc]: https://godoc.org/go.uber.org/config
[ci-img]: https://github.com/uber-go/config/actions/workflows/go.yml/badge.svg
[ci]: https://github.com/uber-go/config/actions/workflows/go.yml
[cov-img]: https://codecov.io/gh/uber-go/config/branch/master/graph/badge.svg
[cov]: https://codecov.io/gh/uber-go/config/branch/master