1cli
2===
3
4[![GoDoc](https://godoc.org/github.com/urfave/cli?status.svg)](https://godoc.org/github.com/urfave/cli)
5[![codebeat](https://codebeat.co/badges/0a8f30aa-f975-404b-b878-5fab3ae1cc5f)](https://codebeat.co/projects/github-com-urfave-cli)
6[![Go Report Card](https://goreportcard.com/badge/urfave/cli)](https://goreportcard.com/report/urfave/cli)
7[![codecov](https://codecov.io/gh/urfave/cli/branch/master/graph/badge.svg)](https://codecov.io/gh/urfave/cli)
8
9cli is a simple, fast, and fun package for building command line apps in Go. The
10goal is to enable developers to write fast and distributable command line
11applications in an expressive way.
12
13## Usage Documentation
14
15Usage 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`.
16
17- `v2` - [./docs/v2/manual.md](./docs/v2/manual.md)
18- `v1` - [./docs/v1/manual.md](./docs/v1/manual.md)
19
20Guides for migrating to newer versions:
21
22- `v1-to-v2` - [./docs/migrate-v1-to-v2.md](./docs/migrate-v1-to-v2.md)
23
24## Installation
25
26Using this package requires a working Go environment. [See the install instructions for Go](http://golang.org/doc/install.html).
27
28Go Modules are required when using this package. [See the go blog guide on using Go Modules](https://blog.golang.org/using-go-modules).
29
30### Using `v2` releases
31
32```
33$ GO111MODULE=on go get github.com/urfave/cli/v2
34```
35
36```go
37...
38import (
39  "github.com/urfave/cli/v2" // imports as package "cli"
40)
41...
42```
43
44### Using `v1` releases
45
46```
47$ GO111MODULE=on go get github.com/urfave/cli
48```
49
50```go
51...
52import (
53  "github.com/urfave/cli"
54)
55...
56```
57
58### GOPATH
59
60Make sure your `PATH` includes the `$GOPATH/bin` directory so your commands can
61be easily used:
62```
63export PATH=$PATH:$GOPATH/bin
64```
65
66### Supported platforms
67
68cli is tested against multiple versions of Go on Linux, and against the latest
69released version of Go on OS X and Windows. This project uses Github Actions for
70builds. 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).
71