tar-split/vendor/github.com/urfave/cli/README.md

1.6 KiB

cli

Run Tests Go Reference Go Report Card codecov

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 for v1 is available at the docs site or in-tree at ./docs/v1/manual.md

Installation

Make sure you have a working Go environment. Go version 1.18+ is supported.

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. For full details, see ./.github/workflows/cli.yml.

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.

Using v1 releases

$ go get github.com/urfave/cli
...
import (
  "github.com/urfave/cli"
)
...