1
0
mirror of https://github.com/go-micro/go-micro.git synced 2024-12-18 08:26:38 +02:00
go-micro/config/source/cli
2023-04-26 02:21:08 +02:00
..
cli_test.go fix: some linting issues (#2563) 2022-09-30 16:27:07 +02:00
cli.go fix(config/source/cli): mergo.Map error, src and dst must be of same … (#2628) 2023-04-26 02:21:08 +02:00
options.go fix: some linting issues (#2563) 2022-09-30 16:27:07 +02:00
README.md fix: linting issues (#2566) 2022-09-30 20:32:55 +02:00
util.go Move from micro/cli/v2 to urfave/cli/v2 (#2224) 2021-08-31 09:05:08 +01:00

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

micro.Flags(
    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",
    },
)

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
    service := micro.NewService(
        micro.Name("example"),
        micro.Flags(
            cli.StringFlag{
                Name: "database-address",
                Value: "127.0.0.1",
                Usage: "the db address",
            },
        ),
    )

    var clisrc source.Source

    service.Init(
        micro.Action(func(c *cli.Context) {
            clisrc = cli.NewSource(
                cli.Context(c),
	    )
            // Alternatively, just setup your config right here
        }),
    )

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