flag

README

Flag Source

The flag source reads config from flags

Format

We expect the use of the flag package. Upper case flags will be lower cased. Dashes will be used as delimiters.

Example

dbAddress := flag.String("database-address", "127.0.0.1", "the db address")
dbPort := flag.Int("database-port", 3306, "the db port)

Becomes

{
    "database": {
        "address": "127.0.0.1",
        "port": 3306
    }
}

New Source

flagSource := flag.NewSource(
	// optionally enable reading of unset flags and their default
	// values into config, defaults to false
	IncludeUnset(true)
)

Load Source

Load the source into config

// Create new config
conf := config.NewConfig()

// Load flag source
conf.Load(flagSource)

Documentation

Index

• func IncludeUnset(b bool) source.Option
• func NewSource(opts ...source.Option) source.Source

Functions

func IncludeUnset

func IncludeUnset(b bool) source.Option

IncludeUnset toggles the loading of unset flags and their respective default values. Default behavior is to ignore any unset flags.

func NewSource

func NewSource(opts ...source.Option) source.Source

NewSource returns a config source for integrating parsed flags. Hyphens are delimiters for nesting, and all keys are lowercased.

Example:

dbhost := flag.String("database-host", "localhost", "the db host name")

{
    "database": {
        "host": "localhost"
    }
}