Merge pull request #1371 from urfave/release-metadata

Cleaning up some release-related metadata & docs

2022-04-26 07:58:08 -04:00

2.4 KiB

Raw Blame History

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 main branch, which is currently v2.

v2 - ./docs/v2/manual.md
v1 - ./docs/v1/manual.md

Guides for migrating to newer versions:

v1-to-v2 - ./docs/migrate-v1-to-v2.md

Installation

Using this package requires a working Go environment. See the install instructions for Go.

Go Modules are required when using this package. See the go blog guide on using Go Modules.

Using `v2` releases

$ go get github.com/urfave/cli/v2

...
import (
  "github.com/urfave/cli/v2" // imports as package "cli"
)
...

Using `v1` releases

$ go get github.com/urfave/cli

...
import (
  "github.com/urfave/cli"
)
...

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.

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. To see our currently supported go versions and platforms, look at the ./.github/workflows/cli.yml.

License

See LICENSE

2.4 KiB Raw Blame History

cli