Arbitrary CLI flags parser, like argparse in Python.
Go to file
Stanislav N. aka pztrn 1330c5f1b6 Allow to skip specifying logger so default log package will be used. 2018-04-27 13:25:27 +05:00
.gitignore Initial commit. 2017-08-20 14:59:51 +05:00
.travis.yml Relicensed under MIT. 2018-03-23 08:14:25 +05:00
LICENSE Relicensed under MIT. 2018-03-23 08:14:25 +05:00
README.md GoDoc link updated. 2018-03-23 08:28:03 +05:00
exported.go Allow to skip specifying logger so default log package will be used. 2018-04-27 13:25:27 +05:00
flag.go Relicensed under MIT. 2018-03-23 08:14:25 +05:00
flagger.go Fixed logger interface to be compatible with wider range of loggers. 2018-04-27 13:13:23 +05:00
flagger_test.go Allow to skip specifying logger so default log package will be used. 2018-04-27 13:25:27 +05:00
loggerinterface.go Fixed logger interface to be compatible with wider range of loggers. 2018-04-27 13:13:23 +05:00

README.md

GoDoc Build Status

Flagger

Flagger is an arbitrary CLI flags parser, like argparse in Python. Flagger is able to parse boolean, integer and string flags.

Installation

go get -u -v lab.pztrn.name/golibs/flagger

Usage

Flagger requires logging interface to be passed on initialization. See loggerinterface.go for required logging functions. It is able to run with standart log package, in that case initialize flagger like:

flgr = flagger.New(flagger.LoggerInterface(log.New(os.Stdout, "testing logger: ", log.Lshortfile)))
flgr.Initialize()

Adding a flag is easy, just fill Flag structure and pass to AddFlag() call:

flag_bool := Flag{
    Name: "boolflag",
    Description: "Boolean flag",
    Type: "bool",
    DefaultValue: true,
}
err := flgr.AddFlag(&flag_bool)
if err != nil {
    ...
}

After adding all neccessary flags you should issue Parse() call to get them parsed:

flgr.Parse()

After parsed they can be obtained everywhere you want, like:

val, err := flgr.GetBoolValue("boolflag")
if err != nil {
    ...
}

For more examples take a look at flagger_test.go file or at GoDoc.