959cf9de8a
Some of the docs were lacking or incomplete concerning how to properly use cli.Exit, cli.HandleExitCoder, and the ExitErrHandler field on cli.App. This change aims to clarify the usage of those pieces. I also noticed that we have two identical functions now: cli.Exit and cli.NewExitError. Since the latter seems to be more recent and less well documented, I went ahead and marked it as deprecated so that we can keep our public interface small. Also added a missing test case for behavior that's been around a while but was not documented or tested. Related: #1089 |
||
|---|---|---|
| .github | ||
| altsrc | ||
| autocomplete | ||
| docs | ||
| internal | ||
| testdata | ||
| .flake8 | ||
| .gitignore | ||
| app_test.go | ||
| app.go | ||
| args.go | ||
| category.go | ||
| cli.go | ||
| CODE_OF_CONDUCT.md | ||
| command_test.go | ||
| command.go | ||
| context_test.go | ||
| context.go | ||
| docs_test.go | ||
| docs.go | ||
| errors_test.go | ||
| errors.go | ||
| fish_test.go | ||
| fish.go | ||
| flag_bool.go | ||
| flag_duration.go | ||
| flag_float64_slice.go | ||
| flag_float64.go | ||
| flag_generic.go | ||
| flag_int64_slice.go | ||
| flag_int64.go | ||
| flag_int_slice.go | ||
| flag_int.go | ||
| flag_path.go | ||
| flag_string_slice.go | ||
| flag_string.go | ||
| flag_test.go | ||
| flag_timestamp.go | ||
| flag_uint64.go | ||
| flag_uint.go | ||
| flag.go | ||
| funcs.go | ||
| go.mod | ||
| go.sum | ||
| help_test.go | ||
| help.go | ||
| helpers_test.go | ||
| LICENSE | ||
| parse.go | ||
| README.md | ||
| sort_test.go | ||
| sort.go | ||
| template.go | ||
cli
cli is a simple, fast, and fun package for building command line apps in Go. The goal is to enable developers to write fast and distributable command line applications in an expressive way.
Usage Documentation
Usage documentation exists for each major version. Don't know what version you're on? You're probably using the version from the master branch, which is currently v2.
v2- ./docs/v2/manual.mdv1- ./docs/v1/manual.md
Installation
Using this package requires a working Go environment. See the install instructions for Go.
Go Modules are required when using this package. See the go blog guide on using Go Modules.
Using v2 releases
$ GO111MODULE=on go get github.com/urfave/cli/v2
...
import (
"github.com/urfave/cli/v2" // imports as package "cli"
)
...
Using v1 releases
$ GO111MODULE=on go get github.com/urfave/cli
...
import (
"github.com/urfave/cli"
)
...
GOPATH
Make sure your PATH includes the $GOPATH/bin directory so your commands can
be easily used:
export PATH=$PATH:$GOPATH/bin
Supported platforms
cli is tested against multiple versions of Go on Linux, and against the latest released version of Go on OS X and Windows. This project uses Github Actions for builds. To see our currently supported go versions and platforms, look at the ./.github/workflows/cli.yml.