gonfig

gonfig

All-in-one solution for managing configuration from environment values and flags.

Usage

Running the following using the following command would yield localhost:3000?key=secret

go run ./main.go -api-key=secret

package main

import (
	"flag"
	"fmt"
	"os"

	"github.com/axatol/gonfig"
)

type config struct {
	Host   string `env:"HOST"`
	Port   int    `env:"PORT" default:"3000"`
	ApiKey string `flag:"api-key"`
}

func init() {
	os.Setenv("HOST", "localhost")
	os.argv
}

// load config using defaults
func example1() {
	cfg := config{}
	_ = gonfig.Load(&cfg)
	fmt.Printf("%s:%d?key=%s\n", cfg.Host, cfg.Port, cfg.ApiKey)
}

// or manually run each step
func example2() {
	// initialise configurator
	fs, _ := gonfig.NewConfig(&cfg)

	// load env vars first
	_ = fs.ReadEnv()

	// register cli flags
	_ = fs.BindFlags(flag.CommandLine)

	// process args as usual
	flag.Parse()

	// ensure required fields are set
	_ = fs.Validate()

	fmt.Printf("%s:%d?key=%s\n", cfg.Host, cfg.Port, cfg.ApiKey)
}