consul/vendor/github.com/mitchellh/cli
Frank Schroeder c0680660d5
vendor: patch github.com/mitchellh/cli until help output is fixed
We need to init the flagset that cli uses to generate the help
outside of the Run method since Run isn't called anymore for
printing help.
2017-05-31 00:29:29 +02:00
..
LICENSE Manage dependencies via Godep 2016-02-12 16:50:37 -08:00
Makefile Updates mattn/go-isatty and mitchellh/cli. 2016-08-09 17:26:11 -07:00
README.md vendor: update github.com/mitchellh/cli 2017-05-31 00:29:25 +02:00
cli.go vendor: patch github.com/mitchellh/cli until help output is fixed 2017-05-31 00:29:29 +02:00
command.go Manage dependencies via Godep 2016-02-12 16:50:37 -08:00
command_mock.go Manage dependencies via Godep 2016-02-12 16:50:37 -08:00
help.go vendor: update github.com/mitchellh/cli 2017-05-31 00:29:25 +02:00
ui.go Manage dependencies via Godep 2016-02-12 16:50:37 -08:00
ui_colored.go Manage dependencies via Godep 2016-02-12 16:50:37 -08:00
ui_concurrent.go Manage dependencies via Godep 2016-02-12 16:50:37 -08:00
ui_mock.go vendor: update github.com/mitchellh/cli 2017-05-31 00:29:25 +02:00
ui_writer.go Manage dependencies via Godep 2016-02-12 16:50:37 -08:00

README.md

Go CLI Library GoDoc

cli is a library for implementing powerful command-line interfaces in Go. cli is the library that powers the CLI for Packer, Serf, Consul, Vault, Terraform, and Nomad.

Features

  • Easy sub-command based CLIs: cli foo, cli bar, etc.

  • Support for nested subcommands such as cli foo bar.

  • Optional support for default subcommands so cli does something other than error.

  • Automatic help generation for listing subcommands

  • Automatic help flag recognition of -h, --help, etc.

  • Automatic version flag recognition of -v, --version.

  • Helpers for interacting with the terminal, such as outputting information, asking for input, etc. These are optional, you can always interact with the terminal however you choose.

  • Use of Go interfaces/types makes augmenting various parts of the library a piece of cake.

Example

Below is a simple example of creating and running a CLI

package main

import (
	"log"
	"os"

	"github.com/mitchellh/cli"
)

func main() {
	c := cli.NewCLI("app", "1.0.0")
	c.Args = os.Args[1:]
	c.Commands = map[string]cli.CommandFactory{
		"foo": fooCommandFactory,
		"bar": barCommandFactory,
	}

	exitStatus, err := c.Run()
	if err != nil {
		log.Println(err)
	}

	os.Exit(exitStatus)
}