Skip to content

Latest commit

 

History

History
71 lines (53 loc) · 1.26 KB

README.md

File metadata and controls

71 lines (53 loc) · 1.26 KB

ArguDuck

A quacking simple argmuent parser for Go.

Installation

go get github.com/duck-fat-studios/ArguDcuk

Argument Types

Flag

Flag(name string, short string, help string, group ...string) (error, ArguDuckErrorString)

Float

Float(name string, short string, defaultValue float64, help string, group ...string) (error, ArguDuckErrorString)

Int

Int(name string, short string, defaultValue int, help string, group ...string) (error, ArguDuckErrorString) 

String

String(name string, short string, defaultValue string, help string, group ...string) (error, ArguDuckErrorString)

Basic Usage

package main

import (
    arguduck "github.com/duck-fat-studios/ArguDuck"
)

var (
    args = *arguduck.InitArguDuck()
)

func main() {
    setupArguments()

    fmt.Println(arguduck.Args["foo"])
    // >> Bar

}

func setupArguments() {
    args.SetAbout("this is the message")
    args.String("foo", "f", "bar", "Prints Bar", "FooBar")
    args.Parse()
}

Error Handling

err, errString := args.String("foo", "f", "bar", "FOOBAR!", "FooBar")

if err != nil {
    fmt.Printf("%s: %s\n", errString, err)
}