2016-06-16 15:47:19 +00:00
cli
===
2016-05-22 21:42:23 +00:00
[](https://godoc.org/github.com/urfave/cli)
[](https://codebeat.co/projects/github-com-urfave-cli)
[](https://goreportcard.com/report/urfave/cli)
2019-08-07 15:30:07 +00:00
[](https://codecov.io/gh/urfave/cli)
2016-05-10 18:40:56 +00:00
2016-05-31 19:49:48 +00:00
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.
2013-07-15 01:01:26 +00:00
2019-10-12 07:59:50 +00:00
## Usage Documentation
2019-11-13 22:03:36 +00:00
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` .
2019-10-12 07:59:50 +00:00
2019-11-09 06:29:06 +00:00
- `v2` - [./docs/v2/manual.md ](./docs/v2/manual.md )
2019-11-13 22:03:36 +00:00
- `v1` - [./docs/v1/manual.md ](./docs/v1/manual.md )
2019-10-12 07:59:50 +00:00
2019-12-24 09:22:07 +00:00
## Installation
2020-03-09 08:14:51 +00:00
Using this package requires a working Go environment. [See the install instructions for Go ](http://golang.org/doc/install.html ).
2019-12-24 09:22:07 +00:00
2020-03-09 08:14:51 +00:00
Go Modules are required when using this package. [See the go blog guide on using Go Modules ](https://blog.golang.org/using-go-modules ).
2019-12-24 09:22:07 +00:00
2019-11-13 22:03:36 +00:00
### Using `v2` releases
2013-07-15 14:44:17 +00:00
2013-07-15 15:06:43 +00:00
```
2019-11-29 08:22:44 +00:00
$ GO111MODULE=on go get github.com/urfave/cli/v2
2013-07-15 15:06:43 +00:00
```
2019-11-13 22:03:36 +00:00
```go
...
import (
2019-11-14 20:51:31 +00:00
"github.com/urfave/cli/v2" // imports as package "cli"
2019-11-13 22:03:36 +00:00
)
...
```
2016-05-24 00:34:33 +00:00
2019-08-14 04:10:38 +00:00
### Using `v1` releases
2016-05-16 14:46:43 +00:00
2019-08-15 19:30:29 +00:00
```
2019-12-24 09:22:07 +00:00
$ GO111MODULE=on go get github.com/urfave/cli
2019-08-15 19:30:29 +00:00
```
2019-08-14 18:20:58 +00:00
2019-08-15 19:30:29 +00:00
```go
...
2019-08-14 18:20:58 +00:00
import (
"github.com/urfave/cli"
)
2019-08-15 19:30:29 +00:00
...
```
2016-05-16 14:46:43 +00:00
2019-11-13 22:03:36 +00:00
### GOPATH
Make sure your `PATH` includes the `$GOPATH/bin` directory so your commands can
be easily used:
2015-12-09 17:15:46 +00:00
```
2019-11-13 22:03:36 +00:00
export PATH=$PATH:$GOPATH/bin
2013-07-20 22:58:51 +00:00
```
2013-07-15 15:19:49 +00:00
2019-11-13 22:03:36 +00:00
### Supported platforms
cli is tested against multiple versions of Go on Linux, and against the latest
2019-12-19 13:22:26 +00:00
released version of Go on OS X and Windows. This project uses Github Actions for
2020-03-09 08:13:18 +00:00
builds. To see our currently supported go versions and platforms, look at the [./.github/workflows/cli.yml ](https://github.com/urfave/cli/blob/master/.github/workflows/cli.yml ).
