mirror of https://github.com/hashicorp/consul
68 lines
1.7 KiB
Markdown
68 lines
1.7 KiB
Markdown
# Go CLI Library [](https://godoc.org/github.com/mitchellh/cli)
|
|
|
|
cli is a library for implementing powerful command-line interfaces in Go.
|
|
cli is the library that powers the CLI for
|
|
[Packer](https://github.com/mitchellh/packer),
|
|
[Serf](https://github.com/hashicorp/serf),
|
|
[Consul](https://github.com/hashicorp/consul),
|
|
[Vault](https://github.com/hashicorp/vault),
|
|
[Terraform](https://github.com/hashicorp/terraform), and
|
|
[Nomad](https://github.com/hashicorp/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
|
|
|
|
```go
|
|
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)
|
|
}
|
|
```
|
|
|