flags

Documentation

Index

• func Parse(args *[]string)
• func PrintUsage()
• func PrintUsageAndExit()
• func PrintUsageAndExitWithCode(code int)
• func RegisterBoolFlag(reference *bool, shortName string, longName string, description string)
• func RegisterStringFlag(reference *string, shortName string, longName string, description string)
• func RegisterUintFlag(reference *uint, shortName string, longName string, description string)
• func SetDetails(name string, link string)
• func SetExample(example string)

Functions

func Parse

func Parse(args *[]string)

Parse parses flags and returns extra args

func PrintUsage

func PrintUsage()

PrintUsage prints CLI flags usage

func PrintUsageAndExit

func PrintUsageAndExit()

PrintUsageAndExit prints CLI flags usage and exits with code 1

func PrintUsageAndExitWithCode

func PrintUsageAndExitWithCode(code int)

PrintUsageAndExitWithCode prints CLI flags usage and exits with code

func RegisterBoolFlag

func RegisterBoolFlag(reference *bool, shortName string, longName string, description string)

RegisterBoolFlag registers a boolean flag

func RegisterStringFlag

func RegisterStringFlag(reference *string, shortName string, longName string, description string)

RegisterStringFlag registers a string flag

func RegisterUintFlag

func RegisterUintFlag(reference *uint, shortName string, longName string, description string)

RegisterUintFlag registers a uint flag

func SetDetails

func SetDetails(name string, link string)

SetDetails set CLI details line

func SetExample

func SetExample(example string)

SetExample set the CLI example