2019-10-16 20:33:36 +05:00
[](https://godoc.org/go.dev.pztrn.name/flagger) [](https://ci.dev.pztrn.name/libraries/flagger/) [](https://discord.gg/qHN6KsD)  [](https://goreportcard.com/report/go.dev.pztrn.name/flagger)
2017-08-20 15:06:37 +05:00
2017-08-20 14:59:51 +05:00
# Flagger
Flagger is an arbitrary CLI flags parser, like argparse in Python.
2017-08-20 15:06:37 +05:00
Flagger is able to parse boolean, integer and string flags.
2017-08-20 14:59:51 +05:00
# Installation
```
2019-10-15 21:20:49 +05:00
go get -u -v go.dev.pztrn.name/flagger
2017-08-20 14:59:51 +05:00
```
# Usage
2017-08-20 15:06:37 +05:00
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:
```
2018-12-18 04:12:55 +05:00
flgr = flagger.New("My Super Program", flagger.LoggerInterface(log.New(os.Stdout, "testing logger: ", log.Lshortfile)))
2017-10-27 07:36:15 +05:00
flgr.Initialize()
2017-08-20 15:06:37 +05:00
```
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 {
...
}
```
2019-01-22 17:38:36 +05:00
For more examples take a look at ``flagger_test.go`` file or [at GoDoc ](https://godoc.org/gitlab.com/pztrn/flagger ).
# Get help
If you want to report a bug - feel free to report it via Gitlab's issues system. Note that everything that isn't a bug report or feature request will be closed without any futher comments.
If you want to request some help (without warranties), propose a feature request or discuss flagger in any way - please use our mailing lists at flagger@googlegroups.com. To be able to send messages there you should subscribe by sending email to ``flagger+subscribe@googlegroups.com``, subject and mail body can be random.
