gonsole

Gonsole

Gonsole is a Go command line argument parsing library. It provides a configurable parser that reads the given arguments to a map[string]string, checking them against the ones it is told to expect.

Installation

go get github.com/nic-gr/gonsole

Usage

import "github.com/nic-gr/gonsole"

Examples

package main

import (
    "fmt"
    "os"

    "github.com/nic-gr/gonsole"
)

func main() {
    argsMap, err := gonsole.
        NewParser().
        WithProgramName("main.go").
        WithArguments(
            gonsole.Argument{Name: "firstArg"},
            gonsole.Argument{Name: "secondArg"},
            gonsole.Argument{Name: "thirdArg", Default: "42"},
        ).
        WithFlags(
            gonsole.Flag{Name: "-i", Alias: "--inputFile", Required: true},
            gonsole.Flag{Name: "-o", Description: "output file", Default: "/dev/null"},
            gonsole.Flag{Name: "-v", Alias: "--verbose", Boolean: true},
            gonsole.Flag{
                Name: "-g",
                Domain: []string{"Hello", "Hola", "Ciao"},
                Check: func(value string) error {
                    if value != "Hello" {
                        return fmt.Errorf("other languages will be supported soon!")
                    }

                    return nil
                },
            },
        ).
        WithDescription("Gonsole example").
        WithValidation(func(argsMap map[string]string) error {
            _, okG := argsMap["g"]
            _, okV := argsMap["v"]

            if okG && !okV {
                return fmt.Errorf("if the -g flag is provided, the -v (--verbose) flag is mandatory")
            }

            return nil
        }).
        Parse()

    if err != nil {
        fmt.Fprintf(os.Stderr, "%s\n", err.Error())
        os.Exit(1)
    }

    fmt.Println(argsMap)
}

$ go run main.go -i="/proc" -o /media --verbose 12 24
map[firstArg:12 i:/proc inputFile:/proc o:/media secondArg:24 thirdArg:42 v: verbose:]

$ go run main.go -h
usage: main.go [-h, --help] [-i, --inputFile I] [-o O] [-v, --verbose] [-g G] firstArg secondArg thirdArg

Gonsole example

positional arguments:
    firstArg                              
    secondArg                             
    thirdArg (default "42")                 

flags:
    -h, --help                            show this help message and exit
    -i, --inputFile I (required)          
    -o O (default "/dev/null")              output file
    -v, --verbose                         
    -g G (with domain, checked)

License

MIT