2021-02-01 00:10:16 +01:00
cli
===
2022-03-16 12:55:03 +01:00
[![GoDoc ](https://godoc.org/github.com/urfave/cli?status.svg )](https://pkg.go.dev/github.com/urfave/cli/v2)
2021-02-01 00:10:16 +01:00
[![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)
2022-04-26 14:24:23 +02:00
[![codecov ](https://codecov.io/gh/urfave/cli/branch/main/graph/badge.svg )](https://codecov.io/gh/urfave/cli)
2021-02-01 00:10:16 +01: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.
## Usage Documentation
2022-04-26 14:24:23 +02:00
Usage documentation exists for each major version. Don't know what version you're on? You're probably using the version from the `main` branch, which is currently `v2` .
2021-02-01 00:10:16 +01:00
- `v2` - [./docs/v2/manual.md ](./docs/v2/manual.md )
- `v1` - [./docs/v1/manual.md ](./docs/v1/manual.md )
Guides for migrating to newer versions:
- `v1-to-v2` - [./docs/migrate-v1-to-v2.md ](./docs/migrate-v1-to-v2.md )
## Installation
Using this package requires a working Go environment. [See the install instructions for Go ](http://golang.org/doc/install.html ).
Go Modules are required when using this package. [See the go blog guide on using Go Modules ](https://blog.golang.org/using-go-modules ).
### Using `v2` releases
```
2022-04-26 14:24:23 +02:00
$ go get github.com/urfave/cli/v2
2021-02-01 00:10:16 +01:00
```
```go
...
import (
"github.com/urfave/cli/v2" // imports as package "cli"
)
...
```
### Using `v1` releases
```
2022-04-26 14:24:23 +02:00
$ go get github.com/urfave/cli
2021-02-01 00:10:16 +01:00
```
```go
...
import (
"github.com/urfave/cli"
)
...
```
2022-04-26 14:24:23 +02:00
### 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.
2021-02-01 00:10:16 +01: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
2022-04-26 14:24:23 +02:00
builds. To see our currently supported go versions and platforms, look at the [./.github/workflows/cli.yml ](https://github.com/urfave/cli/blob/main/.github/workflows/cli.yml ).
2022-05-02 15:00:32 +02:00
## License
See [`LICENSE` ](./LICENSE )