srinathh / flagconf

Easy TOML + flags configuration for Go programs.

flagconf

Package flagconf combines the standard library's flag package with Andrew Gallant's excellent TOML parsing library.

This package sets program options from a TOML configuration file while allowing the settings to be overridden with command-line flags as well.

Installation

$ go get -u github.com/cespare/flagconf

Usage

Here is a small example:

import (
  "github.com/cespare/flagconf"
)

type Config struct {
  MaxProcs int    `desc:"maximum OS threads"`
  Addr     string `desc:"listen address (with port)"`
}

func main() {
  // Set the defaults
  config := Config{
    MaxProcs: 4,
  }
  flagconf.Parse("config.toml", &config)
}

Now if your toml looks like this:

maxprocs = 8
addr = "localhost:7755"

and you run your program with

$ ./prog -addr ":8888"

then conf will be:

MaxProcs: 8
Addr: ":8888"

(That is, TOML settings override the defaults and flags given override those.)

Full documentation may be found on godoc.org or by using any of the usual documentation viewing methods for this package.

License

MIT