open-nomad/vendor/github.com/mitchellh/cli
Seth Hoenig 435c0d9fc8 deps: Switch to Go modules for dependency management
This PR switches the Nomad repository from using govendor to Go modules
for managing dependencies. Aspects of the Nomad workflow remain pretty
much the same. The usual Makefile targets should continue to work as
they always did. The API submodule simply defers to the parent Nomad
version on the repository, keeping the semantics of API versioning that
currently exists.
2020-06-02 14:30:36 -05:00
..
.travis.yml deps: Switch to Go modules for dependency management 2020-06-02 14:30:36 -05:00
LICENSE Using godeps to build 2016-02-12 10:02:16 -08:00
Makefile vendor updated cli and autocomplete dependencies 2017-08-25 16:43:49 +00:00
README.md Fix autocmpleting global flags 2017-07-28 09:44:48 -07:00
autocomplete.go Add command autocompletion. 2017-07-17 15:00:40 -07:00
cli.go deps: Switch to Go modules for dependency management 2020-06-02 14:30:36 -05:00
command.go Add command autocompletion. 2017-07-17 15:00:40 -07:00
command_mock.go Add command autocompletion. 2017-07-17 15:00:40 -07:00
go.mod deps: Switch to Go modules for dependency management 2020-06-02 14:30:36 -05:00
go.sum deps: Switch to Go modules for dependency management 2020-06-02 14:30:36 -05:00
help.go Vendor new cli 2017-03-02 19:23:01 -08:00
ui.go Using godeps to build 2016-02-12 10:02:16 -08:00
ui_colored.go vendor: update mitchellh/cli and transitive deps 2018-04-09 18:02:14 -04:00
ui_concurrent.go Using godeps to build 2016-02-12 10:02:16 -08:00
ui_mock.go vendor updated cli and autocomplete dependencies 2017-08-25 16:43:49 +00:00
ui_writer.go Using godeps to build 2016-02-12 10:02:16 -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.

  • Support for shell autocompletion of subcommands, flags, and arguments with callbacks in Go. You don't need to write any shell code.

  • 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)
}