README.md

features

• struct base
• tag (cli:"names, n" help:"help message" default:"parsable literal")
  • for sub commands (cli, help, usage)
  • for options (cli, help, default, env, required)
• sub command as a member struct in a parent struct
  • sub sub ... command
• extra sub command
• user defined option types (example: gli.Range, gli.IntList, ...)
• pointer type options
• hook functions Init/Before/Run/After/Help as methods of commands

go get

go get github.com/shu-go/gli

example app:

go get github.com/shu-go/gli/example/todo

This introduces an executable binary todo.

Examples

Example1: Simple

type Global struct {
    Opt1 string
    Opt2 int
}

func main() {
    app := gli.New(&Global{})
    _, _, err := app.Run(os.Args)
    // :
}

func (g *Global) Run(args []string) {
}

// app --opt1 abc --opt2 123
// app --opt1=abc --opt2=123

Example2: Renaming

type Global struct {
    Opt1 string `cli:"s, str"`
    Opt2 int    `cli:"i, int, opt2"`
}

// :

// app --opt1 abc --opt2 123 <-- NG: opt1 is not defined (while opt2 is defined)
// app -s abc -i 123
// app --str abc --int 123

Example3: Sub command

type Global struct {
    Opt1 string `cli:"s, str"`
    Opt2 int    `cli:"i, int, opt2"`

    Sub1 mySub
}

type mySub struct {
    Opt3 string
    
    Sub2 mySubSub `cli:s, sub2`
}

func (sub *mySub) Run(g *Global, args []string) {
}

func (subsub *mySubSub) Run(g *Global, args []string, sub *mySub) {
}

// app --str abc --int 123 sub1 --opt3 def

Example4: Hook functions

Commnds (root and sub commands) may have some hook functions.

Define receivers for the target commands.

func (subsub *mySubSub) Run(g *Global, args []string, sub *mySub) {
}

• Run
  • is called for the target command
• Before
  • are called for root -> sub -> subsub(target, in this case)
  • With any error, Run is not called.
• After
  • are called for subsub(target, in this case) -> sub -> root
• Init
  • are called for root -> sub -> subsub(target, in this case)
  • These functions are for initialization of command struct.
• Help
  • prints help message.
  • subsub(target, in this case) -> root

Run

1. Init for all commands
2. Before for all commands
   • and defer calling After
3. Run

Help

1. Init for all commands
2. first defined Help, subsub -> root

Signature

Parameters are in arbitrary order, omittable.

• []string
• struct{...} or *struct{...} of command

// OK
func (subsub *mySubSub) Run(args []string, g *Global, sub *mySub) error {
}
// OK
func (subsub *mySubSub) Run(g *Global, args []string, sub *mySub) error {
}
// OK
func (subsub *mySubSub) Run(args []string, sub *mySub) error {
}
// OK
func (subsub *mySubSub) Run(sub *mySub) error {
}

Return value is nothing or an error.

func (subsub *mySubSub) Run() {
}
func (subsub *mySubSub) Run() error {
}

Example5: No Hook

Using gli to get values. No Run() implemented.

type Global struct {
    Opt1 string
    Opt2 int
    Sub1 *Sub1Cmd
}

type Sub1Cmd struct {
    Opt3 string
}

func main() {
    g := Global{}
    app := gli.New(&g)
    tgt, tgtargs, err := app.Run(os.Args, false) // no hook

    // traverse g
    println(g.Opt1) // abc
    println(g.Opt2) // 123
    if g.Sub1 != nil {
        println(g.Sub1.Opt3) // def
    }

    if sub1, ok := tgt.(*Sub1Cmd); ok {
        println(sub1.Opt3) // def
    }
    println(tgtargs) // g h i
}

func (g *Global) Run(args []string) {
    // not called
}

// app --opt1 abc --opt2 123 sub1 --opt3 def  g h i

Example6: Extra Command

type Global struct {}

func main() {
    ex := extra{
        Name string `cli:"n"`
    }{}

    app := gli.New(&Global{})
    app.AddExtraCommand(&ex, "extra", "help message")
}

// app extra -n abc

Example7: User defined option types

type MyOption struct {
    Data int
}

func (o *MyOption) Parse(s string) error {
    o.Data = len(s)
}

//

type Global struct {
    My MyOption
}

Example8: more tags

type Global struct {
    Opt1 string `cli:"opt1=PLACE_HOLDER" default:"default value" env:"ENV_OPT1" help:"help message"`
    Opt2 int    `cli:"opt2" required:"true"`
    Sub MySub   `cli:"sub" help:"help message" usage:"multi line usages\nseparated by \\n"`
}

Options:

• cli
  • renaming
  • cli:"name1, name2, ..., nameZ=PLACE_HOLDER"
• default
  • in string literal
  • bool, float, int and uint are converted by strconv.ParseXXX
  • other types are required implement func Parse (see Example7)
  • use Init hook function for dynamic default values
• env
  • environment variable name
• required
  • bool (true/false)
    • true if the option is given in the command line
  • checked just before Before or Run hook function is executed
  • this check is not affected by Init, Before, After hook function nor default tag
• type
  • User defined decoder
• help

Sub commands:

• cli
• help
• usage
  • multi line usage description separated by \n.

Option value overwriting:

1. default tag
2. env tag
3. Init hook function

Example9: alternative help and usage of commands

type Global struct {
    Sub1 SubCommand1 `cli:"s1"  help:"a command"  usage:"s1 [anything]"`
    Sub2 SubCommand2 `cli:"s2"` // no help and usage
}

type SubCommand2 struct {
    help struct{} `help:"another command" usage:"s2 [something]"`

    // Underscore is also OK.
    //_ struct{} `help:"another command" usage:"s2 [something]"` 
}

Both Sub1 and Sub2 are handled as have same tags.

Decoding optional values

go built-in types

Using reflection, gli sets a given value to each option.

time.Time

Local time and only "yyyy/mm/dd" or "yyyy-mm-dd" formats are supported. (to override, see User defined decoder)

time.Duration

time.ParseDuration

[]string, []int

--opt 1,2,3

map[string]string

--opt key:value,key:value

gli.Range

--opt 1:100

gli.Range has two fields, r.Min and r.Max.

Separator

It replaces []rune{'\', 'n'} to "\n" and []rune{'\','t'} to "\t".

The field should have gli.Separator type or a string type with a struct tag type:"Separator".

type MyCommand struct {
    Sep1 gli.Separator

    Sep2 string `type:"Separator"`
}

SeparatorRune

The field type should be gli.SeparatorRune type or a rune type with a structure tag type:"SeparatorRune".

Choice

type MyCommand struct {
    YourPlace string `type:"Choice" choices:"home,scool,office"`
}

User defined decoder

1. Define a decoder function as TypeDecoder
2. Call [gli.RegisterTypeDecoder](reflect.TypeOf(anyValueOfTheType), decoderFunc)
3. Call [gli.RegisterTypeDecoder]("a string value for struct tag 'type'", decoderFunc)

// s is a string to decode.
// v is a option itself as reflect.Value.
// tag is a StructTag of the option.
type TypeDecoder func(s string, v reflect.Value, tag reflect.StructTag, firstTime bool) error

// For an example: time.Time
func timeDecoder(s string, v reflect.Value, tag reflect.StructTag, firstTime bool) error {
	tm, err := time.ParseInLocation("2006-01-02", s, time.Local)
	if err != nil {
		tm, err = time.ParseInLocation("2006/01/02", s, time.Local)
		if err != nil {
			return err
		}
	}
	v.Set(reflect.ValueOf(tm))
	return nil
}

// For another example: Separator
func separatorDecoder(s string, v reflect.Value, tag reflect.StructTag, firstTime bool) error {
	s = strings.ReplaceAll(s, `\n`, "\n")
	s = strings.ReplaceAll(s, `\t`, "\t")

	v.Set(reflect.ValueOf(s).Convert(v.Type()))

	return nil
}

func init() {
	gli.RegisterTypeDecoder(reflect.TypeOf(time.Time{}), timeDecoder)
	gli.RegisterTypeDecoder("Separator", timeDecoder)
}

---

Copyright 2018 Shuhei Kubota