|
|
|
|
cli
|
|
|
|
|
===
|
|
|
|
|
|
|
|
|
|
[](https://travis-ci.org/urfave/cli)
|
|
|
|
|
[](https://ci.appveyor.com/project/urfave/cli)
|
|
|
|
|
|
|
|
|
|
[](https://godoc.org/github.com/urfave/cli)
|
|
|
|
|
[](https://codebeat.co/projects/github-com-urfave-cli)
|
|
|
|
|
[](https://goreportcard.com/report/urfave/cli)
|
|
|
|
|
[](https://codecov.io/gh/urfave/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
|
|
|
|
|
|
|
|
|
|
- `v1` - [./docs/v1/manual.md](./docs/v1/manual.md)
|
|
|
|
|
- `v2` - 🚧 documentation for `v2` is WIP 🚧
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
Make sure you have a working Go environment. Go version 1.10+ is supported. [See
|
|
|
|
|
the install instructions for Go](http://golang.org/doc/install.html).
|
|
|
|
|
|
|
|
|
|
### 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. For full details, see
|
|
|
|
|
[`./.travis.yml`](./.travis.yml) and [`./appveyor.yml`](./appveyor.yml).
|
|
|
|
|
|
|
|
|
|
### Build tags
|
|
|
|
|
|
|
|
|
|
You can use the following build tags:
|
|
|
|
|
|
|
|
|
|
#### `urfave_cli_no_docs`
|
|
|
|
|
|
|
|
|
|
When set, this removes `ToMarkdown` and `ToMan` methods, so your application
|
|
|
|
|
won't be able to call those. This reduces the resulting binary size by about
|
|
|
|
|
300-400 KB (measured using Go 1.18.1 on Linux/amd64), due to less dependencies.
|
|
|
|
|
|
|
|
|
|
### Using `v1` releases
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ go get github.com/urfave/cli
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
...
|
|
|
|
|
import (
|
|
|
|
|
"github.com/urfave/cli"
|
|
|
|
|
)
|
|
|
|
|
...
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Using `v2` releases
|
|
|
|
|
|
|
|
|
|
**Warning**: `v2` is in a pre-release state.
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ go get github.com/urfave/cli.v2
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
...
|
|
|
|
|
import (
|
|
|
|
|
"github.com/urfave/cli.v2" // imports as package "cli"
|
|
|
|
|
)
|
|
|
|
|
...
|
|
|
|
|
```
|
