flagger/README.md

58 lines
1.4 KiB
Markdown
Raw Normal View History

2018-03-23 08:28:03 +05:00
[![GoDoc](https://godoc.org/github.com/pztrn/flagger?status.svg)](https://godoc.org/github.com/pztrn/flagger) [![Build Status](https://travis-ci.org/pztrn/flagger.svg?branch=master)](https://travis-ci.org/pztrn/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
```
go get -u -v lab.pztrn.name/golibs/flagger
```
# 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)))
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 {
...
}
```
2018-03-23 08:28:03 +05:00
For more examples take a look at ``flagger_test.go`` file or [at GoDoc](https://github.com/pztrn/flagger).