kevinschoon-pomo/vendor/github.com/jawher/mow.cli/README.md

mow.cli

A framework to build command line applications in Go with most of the burden of arguments parsing and validation placed on the framework instead of the developer.

First app

A simple app

package main

import (
    "fmt"
    "os"

    "github.com/jawher/mow.cli"
)

func main() {
    app := cli.App("cp", "Copy files around")

    app.Spec = "[-r] SRC... DST"

    var (
        recursive = app.BoolOpt("r recursive", false, "Copy files recursively")
        src       = app.StringsArg("SRC", nil, "Source files to copy")
        dst       = app.StringArg("DST", "", "Destination where to copy files to")
    )

    app.Action = func() {
        fmt.Printf("Copying %v to %s [recursively: %v]\n", *src, *dst, *recursive)
    }

    app.Run(os.Args)
}

An app with multiple commands:

package main

import (
	"fmt"
	"os"

	"github.com/jawher/mow.cli"
)

func main() {
	app := cli.App("uman", "User Manager")

	app.Spec = "[-v]"

	var (
		verbose = app.BoolOpt("v verbose", false, "Verbose debug mode")
	)

	app.Before = func() {
		if *verbose {
			// Here you can enable debug output in your logger for example
			fmt.Println("Verbose mode enabled")
		}
	}

	// Declare a first command, invocable with "uman list"
	app.Command("list", "list the users", func(cmd *cli.Cmd) {
		// These are the command specific options and args, nicely scoped inside a func
		var (
			all = cmd.BoolOpt("all", false, "Display all users, including disabled ones")
		)

		// What to run when this command is called
		cmd.Action = func() {
			// Inside the action, and only inside, you can safely access the values of the options and arguments
			fmt.Printf("user list (including disabled ones: %v)\n", *all)
		}
	})

	// The second command, invocable with "uman get"
	app.Command("get", "get a user details", func(cmd *cli.Cmd) {
		var (
			detailed = cmd.BoolOpt("detailed", false, "Disaply detailed information")
			id       = cmd.StringArg("ID", "", "The user id to display")
		)

		cmd.Action = func() {
			fmt.Printf("user %q details (detailed mode: %v)\n", *id, *detailed)
		}
	})

	// Now that the app is configured, execute it passing in the os.Args array
	app.Run(os.Args)
}

Motivation

	mow.cli	codegangsta/cli	flag
Contextual help	✓	✓
Commands	✓	✓
Option folding -xyz	✓
Option Value folding -fValue	✓
Option exclusion: --start ❘ --stop	✓
Option dependency : [-a -b] or [-a [-b]]	✓
Arguments validation : SRC DST	✓
Argument optionality : SRC [DST]	✓
Argument repetition : SRC... DST	✓
Option/Argument dependency : SRC [-f DST]	✓
Any combination of the above: [-d ❘ --rm] IMAGE [COMMAND [ARG...]]	✓

In the goland, docopt is another library with rich flags and arguments validation. However, it falls short for many use cases:

	mow.cli	docopt
Contextual help	✓
Backtracking: SRC... DST	✓
Backtracking: [SRC] DST	✓
Branching: (SRC ❘ -f DST)	✓

Installation

To install this library, simply run:

$ go get github.com/jawher/mow.cli

Basics

You start by creating an application by passing a name and a description:

cp := cli.App("cp", "Copy files around")

To attach the code to execute when the app is launched, assign a function to the Action field:

cp.Action = func() {
    fmt.Printf("Hello world\n")
}

If you want you can add support for printing the app version (invoked by -v, --version) like so:

cp.Version("v version", "cp 1.2.3")

Finally, in your main func, call Run on the app:

cp.Run(os.Args)

Options

To add a (global) option, call one of the (String[s]|Int[s]|Bool)Opt methods on the app:

recursive := cp.BoolOpt("R recursive", false, "recursively copy the src to dst")

• The first argument is a space separated list of names (short and long) for the option without the dashes, e.g "f force". While you can specify multiple short or long names, e.g. "f x force force-push", only the first short name and the first long name will be displayed in the help messages
• The second parameter is the default value for the option
• The third and last parameter is the option description, as will be shown in the help messages

There is also a second set of methods Bool, String, Int, Strings and Ints, which accepts a struct describing the option:

recursive = cp.Bool(cli.BoolOpt{
    Name:  "R recursive",
    Value: false,
    Desc:  "copy src files recursively",
    EnvVar: "VAR_RECURSIVE",
    SetByUser: &recursiveSetByUser,
})

EnvVar accepts a space separated list of environment variables names to be used to initialize the option.

If SetByUser is specified (by passing a pointer to a bool variable), it will be set to true if the user explicitly set the option.

The result is a pointer to a value which will be populated after parsing the command line arguments. You can access the values in the Action func.

In the command line, mow.cli accepts the following syntaxes

For boolean options:

• -f : a single dash for the one letter names
• -f=false : a single dash for the one letter names, equal sign followed by true or false
• --force : double dash for longer option names
• -it : mow.cli supports option folding, this is equivalent to: -i -t

For string, int options:

• -e=value : single dash for one letter names, equal sign followed by the value
• -e value : single dash for one letter names, space followed by the value
• -Ivalue : single dash for one letter names immediately followed by the value
• --extra=value : double dash for longer option names, equal sign followed by the value
• --extra value : double dash for longer option names, space followed by the value

For slice options (StringsOpt, IntsOpt):

repeat the option to accumulate the values in the resulting slice:

• -e PATH:/bin -e PATH:/usr/bin : resulting slice contains ["/bin", "/usr/bin"]
• -ePATH:/bin -ePATH:/usr/bin : resulting slice contains ["/bin", "/usr/bin"]
• -e=PATH:/bin -e=PATH:/usr/bin : resulting slice contains ["/bin", "/usr/bin"]
• --env PATH:/bin --env PATH:/usr/bin : resulting slice contains ["/bin", "/usr/bin"]
• --env=PATH:/bin --env=PATH:/usr/bin : resulting slice contains ["/bin", "/usr/bin"]

Arguments

To accept arguments, you need to explicitly declare them by calling one of the (String[s]|Int[s]|Bool)Arg methods on the app:

src := cp.StringArg("SRC", "", "the file to copy")
dst := cp.StringArg("DST", "", "the destination")

• The first argument is the argument name as will be shown in the help messages
• The second parameter is the default value for the argument
• The third parameter is the argument description, as will be shown in the help messages

There is also a second set of methods Bool, String, Int, Strings and Ints, which accepts structs describing the argument:

src = cp.Strings(cli.StringsArg{
    Name:  "SRC",
    Desc:  "The source files to copy",
    Value: "default value",
    EnvVar: "VAR1 VAR2",
    SetByUser: &srcSetByUser,
})

The Value field is where you can set the initial value for the argument.

EnvVar accepts a space separated list of environment variables names to be used to initialize the argument.

If SetByUser is specified (by passing a pointer to a bool variable), it will be set to true only if the user explicitly sets the argument.

The result is a pointer to a value that will be populated after parsing the command line arguments. You can access the values in the Action func.

Operators

The -- operator marks the end of options. Everything that follow will be treated as an argument, even if starts with a dash.

For example, given the touch command which takes a filename as an argument (and possibly other options):

file := cp.StringArg("FILE", "", "the file to create")

If we try to create a file named -f this way:

touch -f

Would fail, because -f will be parsed as an option not as an argument. The fix is to prefix the filename with the -- operator:

touch -- -f

Commands

mow.cli supports nesting commands and sub commands. Declare a top level command by calling the Command func on the app struct, and a sub command by calling the Command func on the command struct:

docker := cli.App("docker", "A self-sufficient runtime for linux containers")

docker.Command("run", "Run a command in a new container", func(cmd *cli.Cmd) {
    // initialize the run command here
})

• The first argument is the command name, as will be shown in the help messages and as will need to be input by the user in the command line to call the command
• The second argument is the command description as will be shown in the help messages
• The third argument is a CmdInitializer, a function that receives a pointer to a Cmd struct representing the command. In this function, you can add options and arguments by calling the same methods as you would with an app struct (BoolOpt, StringArg, ...). You would also assign a function to the Action field of the Cmd struct for it to be executed when the command is invoked.

docker.Command("run", "Run a command in a new container", func(cmd *cli.Cmd) {
    var (
        detached = cmd.BoolOpt("d detach", false, "Detached mode: run the container in the background and print the new container ID")
        memory   = cmd.StringOpt("m memory", "", "Memory limit (format: <number><optional unit>, where unit = b, k, m or g)")
        image    = cmd.StringArg("IMAGE", "", "")
    )
    
    cmd.Action = func() {
        if *detached {
            //do something
        }
        runContainer(*image, *detached, *memory)
    }
})

You can also add sub commands by calling Command on the Cmd struct:

bzk.Command("job", "actions on jobs", func(cmd *cli.Cmd) {
    cmd.Command("list", "list jobs", listJobs)
    cmd.Command("start", "start a new job", startJob)
    cmd.Command("log", "show a job log", nil)
})

When you just want to set Action to cmd, you can use ActionCommand function for this:

app.Command("list", "list all configs", cli.ActionCommand(func() { list() }))

is the same as:

app.Command("list", "list all configs", func(cmd *cli.Cmd)) {
    cmd.Action = func() {
      list()
    }
}

This could go on to any depth if need be.

mow.cli also supports command aliases. For example:

app.Command("start run r", "start doing things", cli.ActionCommand(func() { start() }))

will alias start, run, and r to the same action. Aliases also work for subcommands:

app.Command("job j", "actions on jobs", func(cmd *cli.Cmd) {
    cmd.Command("list ls", "list jobs", func(cmd *cli.Cmd) {
        cmd.Action = func() {
            list()
        }
    })
})

which then allows you to invoke the subcommand as app job list, app job ls, app j ls, or app j list.

As a side-note: it may seem a bit weird the way mow.cli uses a function to initialize a command instead of just returning the command struct.

The motivation behind this choice is scoping: as with the standard flag package, adding an option or an argument returns a pointer to a value which will be populated when the app is run.

Since you'll want to store these pointers in variables, and to avoid having dozens of them in the same scope (the main func for example or as global variables), mow.cli's API was specifically tailored to take a func parameter (called CmdInitializer) which accepts the command struct.

This way, the command specific variables scope is limited to this function.

Custom types

Out of the box, mow.cli supports the following types for options and arguments:

• bool
• string
• int
• strings (slice of strings)
• ints (slice of ints)

You can however extend mow.cli to handle other types, e.g. time.Duration, float64, or even your own struct types for example.

To do so, you'll need to:

• implement the flag.Value interface for the custom type
• declare the option or the flag using VarOpt, VarArg for the short hands, and Var for the full form.

Here's an example:

// Declare your type
type Duration time.Duration

// Make it implement flag.Value
func (d *Duration) Set(v string) error {
	parsed, err := time.ParseDuration(v)
	if err != nil {
		return err
	}
	*d = Duration(parsed)
	return nil
}

func (d *Duration) String() string {
	duration := time.Duration(*d)
	return duration.String()
}

func main() {
    duration := Duration(0)

	app := App("var", "")

	app.VarArg("DURATION", &duration, "")

	app.Run([]string{"cp", "1h31m42s"})
}

Boolean custom types

To make your custom type behave as a boolean option, i.e. doesn't take a value, it has to implement a IsBoolFlag method that returns true:

type BoolLike int


func (d *BoolLike) IsBoolFlag() bool {
	return true
}

Multi-valued custom type

To make your custom type behave as a multi-valued option or argument, i.e. takes multiple values, it has to implement a Clear method which will be called whenever the value list needs to be cleared, e.g. when the value was initially populated from an environment variable, and then explicitly set from the CLI:

type Durations []time.Duration

// Make it implement flag.Value 
func (d *Durations) Set(v string) error {
	parsed, err := time.ParseDuration(v)
	if err != nil {
		return err
	}
	*d = append(*d, Duration(parsed))
	return nil
}

func (d *Durations) String() string {
	return fmt.Sprintf("%v", *d)
}


// Make it multi-valued
func (d *Durations) Clear() {
	*d = []Duration{}
}

Hide default value of custom type

If your custom type implements a IsDefault method (returning a boolean), the help message generation will make use of it to decide whether or not to display the default value.

type Action string

// Make it implement flag.Value
:
:

// Make it multi-valued
func (a *Action) IsDefault() bool {
	return (*a) == "nop"
}

Interceptors

It is possible to define snippets of code to be executed before and after a command or any of its sub commands is executed.

For example, given an app with multiple commands but with a global flag which toggles a verbose mode:

app := cli.App("app", "bla bla")

verbose := app.Bool(cli.BoolOpt{
	Name:  "verbose",
	Value: false,
	Desc:  "Enable debug logs",
})

app.Command("command1", "...", func(cmd *cli.Cmd) {

})

app.Command("command2", "...", func(cmd *cli.Cmd) {

})

Instead of repeating yourself by checking if the verbose flag is set or not, and setting the debug level in every command (and its sub-commands), a before interceptor can be set on the app instead:

app.Before = func() {
	if (*verbose) {
		logrus.SetLevel(logrus.DebugLevel)
	}
}

Whenever a valid command is called by the user, all the before interceptors defined on the app and the intermediate commands will be called, in order from the root to the leaf.

Similarly, if you need to execute a code snippet after a command has been called, e.g. to cleanup resources allocated in before interceptors, simply set the After field of the app struct or any other command. After interceptors will be called, in order from the leaf up to the root (the opposite order of the Before interceptors).

Here's a diagram which shows in when and in which order multiple Before and After interceptors get executed:

Spec

An app or command's call syntax can be customized using spec strings. This can be useful to indicate that an argument is optional for example, or that 2 options are mutually exclusive.

You can set a spec string on:

• The app: to configure the syntax for global options and arguments
• A command: to configure the syntax for that command's options and arguments

In both cases, a spec string is assigned to the Spec field:

cp := cli.App("cp", "Copy files around")
cp.Spec = "[-R [-H | -L | -P]]"

And:

docker := cli.App("docker", "A self-sufficient runtime for linux containers")
docker.Command("run", "Run a command in a new container", func(cmd *cli.Cmd) {
    cmd.Spec = "[-d|--rm] IMAGE [COMMAND [ARG...]]"
    :
    :
}

The spec syntax is mostly based on the conventions used in POSIX command line apps help messages and man pages:

Options

You can use both short and long option names in spec strings:

x.Spec="-f"

And:

x.Spec="--force"

In both cases, we required that the f or force flag be set

Any option you reference in a spec string MUST be explicitly declared, otherwise mow.cli will panic:

x.BoolOpt("f force", ...)

Arguments

Arguments are all-uppercased words:

x.Spec="SRC DST"

This spec string will force the user to pass exactly 2 arguments, SRC and DST

Any argument you reference in a spec string MUST be explicitly declared, otherwise mow.cli will panic:

x.StringArg("SRC", ...)
x.StringArg("DST", ...)

Ordering

Except for options, The order of the elements in a spec string is respected and enforced when parsing the command line arguments:

x.Spec = "-f -g SRC -h DST"

Consecutive options (-f and -g for example) get parsed regardless of the order they are specified in (both -f=5 -g=6 and -g=6 -f=5 are valid).

Order between options and arguments is significant (-f and -g must appear before the SRC argument).

Same goes for arguments, where SRC must appear before DST.

Optionality

You can mark items as optional in a spec string by enclosing them in square brackets :[...]

x.Spec = "[-x]"

Choice

You can use the | operator to indicate a choice between two or more items

x.Spec = "--rm | --daemon"
x.Spec = "-H | -L | -P"
x.Spec = "-t | DST"

Repetition

You can use the ... postfix operator to mark an element as repeatable:

x.Spec="SRC..."
x.Spec="-e..."

Grouping

You can group items using parenthesis. This is useful in combination with the choice and repetition operators (| and ...):

x.Spec = "(-e COMMAND)... | (-x|-y)"

The parenthesis in the example above serve to mark that it is the sequence of a -e flag followed by an argument that is repeatable, and that all that is mutually exclusive to a choice between -x and -y options.

Option group

This is a shortcut to declare a choice between multiple options:

x.Spec = "-abcd"

Is equivalent to:

x.Spec = "(-a | -b | -c | -d)..."

I.e. any combination of the listed options in any order, with at least one option.

All options

Another shortcut:

x.Spec = "[OPTIONS]"

This is a special syntax (the square brackets are not for marking an optional item, and the uppercased word is not for an argument). This is equivalent to a repeatable choice between all the available options. For example, if an app or a command declares 4 options a, b, c and d, [OPTIONS] is equivalent to:

x.Spec = "[-a | -b | -c | -d]..."

Inline option values

You can use the =<some-text> notation right after an option (long or short form) to give an inline description or value.

An example:

x.Spec = "[ -a=<absolute-path> | --timeout=<in seconds> ] ARG"

The inline values are ignored by the spec parser and are just there for the final user as a contextual hint.

Operators

The -- operator can be used in a spec string to automatically treat everything following it as an options.

In other words, placing a -- in the spec string automatically inserts a -- in the same position in the program call arguments.

This lets you write programs like the time utility for example:

x.Spec = "time -lp [-- CMD [ARG...]]"

Grammar

Here's the (simplified) EBNF grammar for the Specs language:

spec         -> sequence
sequence     -> choice*
req_sequence -> choice+
choice       -> atom ('|' atom)*
atom         -> (shortOpt | longOpt | optSeq | allOpts | group | optional) rep? | optEnd
shortOp      -> '-' [A-Za-z]
longOpt      -> '--' [A-Za-z][A-Za-z0-9]*
optSeq       -> '-' [A-Za-z]+
allOpts      -> '[OPTIONS]'
group        -> '(' req_sequence ')'
optional     -> '[' req_sequence ']'
rep          -> '...'
optEnd       -> '--'

And that's it for the spec language. You can combine these few building blocks in any way you want (while respecting the grammar above) to construct sophisticated validation constraints (don't go too wild though).

Behind the scenes, mow.cli parses the spec string and constructs a finite state machine to be used to parse the command line arguments. mow.cli also handles backtracking, and so it can handle tricky cases, or what I like to call "the cp test"

cp SRC... DST

Without backtracking, this deceptively simple spec string cannot be parsed correctly. For instance, docopt can't handle this case, whereas mow.cli does.

Default spec

By default, and unless a spec string is set by the user, mow.cli auto-generates one for the app and every command using this logic:

• Start with an empty spec string
• If at least one option was declared, append [OPTIONS] to the spec string
• For every declared argument, append it, in the order of declaration, to the spec string

For example, given this command declaration:

docker.Command("run", "Run a command in a new container", func(cmd *cli.Cmd) {
    var (
        detached = cmd.BoolOpt("d detach", false, "Detached mode: run the container in the background and print the new container ID", nil)
        memory   = cmd.StringOpt("m memory", "", "Memory limit (format: <number><optional unit>, where unit = b, k, m or g)", nil)
        image    = cmd.StringArg("IMAGE", "", "", nil)
        args     = cmd.StringsArg("ARG", "", "", nil)
    )
})

The auto-generated spec string would be:

[OPTIONS] IMAGE ARG

Which should suffice for simple cases. If not, the spec string has to be set explicitly.

Exiting

mow.cli provides the Exit function which accepts an exit code and exits the app with the provided code.

You are highly encouraged to call cli.Exit instead of os.Exit for the After interceptors to be executed.

License

This work is published under the MIT license.

Please see the LICENSE file for details.