2019-04-25 17:06:53 +00:00
cli
===
[![Windows Build Status ](https://ci.appveyor.com/api/projects/status/rtgk5xufi932pb2v?svg=true )](https://ci.appveyor.com/project/urfave/cli)
2020-01-04 04:45:36 +00:00
2019-04-25 17:06:53 +00:00
[![GoDoc ](https://godoc.org/github.com/urfave/cli?status.svg )](https://godoc.org/github.com/urfave/cli)
[![codebeat ](https://codebeat.co/badges/0a8f30aa-f975-404b-b878-5fab3ae1cc5f )](https://codebeat.co/projects/github-com-urfave-cli)
[![Go Report Card ](https://goreportcard.com/badge/urfave/cli )](https://goreportcard.com/report/urfave/cli)
2020-01-04 04:45:36 +00:00
[![codecov ](https://codecov.io/gh/urfave/cli/branch/master/graph/badge.svg )](https://codecov.io/gh/urfave/cli)
2019-04-25 17:06:53 +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.
2020-01-04 04:45:36 +00:00
## Usage Documentation
2019-04-25 17:06:53 +00:00
2020-01-04 17:44:25 +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-04-25 17:06:53 +00:00
2020-01-04 17:44:25 +00:00
- `v2` - [./docs/v2/manual.md ](./docs/v2/manual.md )
2020-01-04 04:45:36 +00:00
- `v1` - [./docs/v1/manual.md ](./docs/v1/manual.md )
2019-04-25 17:06:53 +00:00
## Installation
2020-01-04 17:44:25 +00:00
Make sure you have a working Go environment. Go version 1.11+ is supported. [See the install instructions for Go ](http://golang.org/doc/install.html ).
2019-04-25 17:06:53 +00:00
2020-01-04 17:44:25 +00:00
Go Modules are strongly recommended when using this package. [See the go blog guide on using Go Modules ](https://blog.golang.org/using-go-modules ).
2019-04-25 17:06:53 +00:00
2020-01-04 17:44:25 +00:00
### Using `v2` releases
2019-04-25 17:06:53 +00:00
```
2020-01-04 17:44:25 +00:00
$ GO111MODULE=on go get github.com/urfave/cli/v2
2019-04-25 17:06:53 +00:00
```
2020-01-04 04:45:36 +00:00
```go
2019-04-25 17:06:53 +00:00
...
import (
2020-01-04 17:44:25 +00:00
"github.com/urfave/cli/v2" // imports as package "cli"
2019-04-25 17:06:53 +00:00
)
...
```
2020-01-04 17:44:25 +00:00
### Using `v1` releases
2019-04-25 17:06:53 +00:00
```
2020-01-04 17:44:25 +00:00
$ GO111MODULE=on go get github.com/urfave/cli
2019-04-25 17:06:53 +00:00
```
2020-01-04 04:45:36 +00:00
```go
2019-04-25 17:06:53 +00:00
...
import (
2020-01-04 17:44:25 +00:00
"github.com/urfave/cli"
2019-04-25 17:06:53 +00:00
)
...
```
2020-01-04 17:44:25 +00:00
### 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. For more build info, please look at the [./.github/workflows/cli.yml ](https://github.com/urfave/cli/blob/master/.github/workflows/cli.yml ).