mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-12-18 08:26:45 +02:00
57 lines
1.3 KiB
Markdown
57 lines
1.3 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), and
|
||
|
|
[Consul](https://github.com/hashicorp/consul).
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
* Easy sub-command based CLIs: `cli foo`, `cli bar`, etc.
|
||
|
|
|
||
|
|
* 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)
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|