2020-08-05 10:49:53 +00:00
cli
===
2021-02-23 19:48:32 +00:00
[](https://pkg.go.dev/github.com/urfave/cli/v2)
2020-08-05 10:49:53 +00:00
[](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. 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.md ](./docs/v2/manual.md )
- `v1` - [./docs/v1/manual.md ](./docs/v1/manual.md )
2021-02-23 19:48:32 +00:00
Guides for migrating to newer versions:
- `v1-to-v2` - [./docs/migrate-v1-to-v2.md ](./docs/migrate-v1-to-v2.md )
2020-08-05 10:49:53 +00:00
## Installation
2021-02-23 19:48:32 +00:00
Using this package requires a working Go environment. [See the install instructions for Go ](http://golang.org/doc/install.html ).
2020-08-05 10:49:53 +00:00
2021-02-23 19:48:32 +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 ).
2020-08-05 10:49:53 +00:00
### Using `v2` releases
```
$ GO111MODULE=on go get github.com/urfave/cli/v2
```
```go
...
import (
"github.com/urfave/cli/v2" // imports as package "cli"
)
...
```
### Using `v1` releases
```
$ GO111MODULE=on go get github.com/urfave/cli
```
```go
...
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
2021-02-23 19:48:32 +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 ).
