cli

cli Source

The cli source reads config from parsed flags via a cli.Context.

Format

We expect the use of the urfave/cli package. Upper case flags will be lower cased. Dashes will be used as delimiters for nesting.

Example

var cliSrc source.Source
app := &cli.App{
    Flags: []cli.Flag{
        cli.StringFlag{
            Name: "database-address",
            Value: "127.0.0.1",
            Usage: "the db address",
        },
        cli.IntFlag{
            Name: "database-port",
            Value: 3306,
            Usage: "the db port",
        },
    },
    Action: func(c *cli.Context) error {
        cliSrc = NewSource(c)
        return nil
    },
}

Becomes

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

New and Load Source

Because a cli.Context is needed to retrieve the flags and their values, it is recommended to build your source from within a cli.Action.

func main() {
    // New Service
	var cliSrc source.Source

    // New App
	app := &cli.App{
		Flags: []cli.Flag{
            cli.StringFlag{
                Name: "database-address",
                Value: "127.0.0.1",
                Usage: "the db address",
            },
		},
		Action: func(c *cli.Context) error {
			cliSrc = NewSource(c)
			return nil
		},
	}

    // ... Load and use that source ...
    conf := config.NewConfig()
    conf.Load(clisrc)
}