Go to file
lynn [they] 7a5ed4801a
Merge pull request #1059 from masonj188/bash-docs
Improved auto-completion instructions and added example gifs
2020-02-06 08:54:00 -08:00
.github simplify GOFMT Check 2020-01-26 17:42:27 +05:30
altsrc Merge branch 'master' into github-actions-windows 2020-01-13 11:29:49 +05:30
autocomplete fix zsh autocomplete 2019-10-06 01:58:51 -07:00
docs Improved auto-completion instructions and example gifs 2020-02-05 17:51:33 -07:00
testdata Fix man page heading formatting 2020-01-15 08:51:07 +01:00
.flake8 Allow slightly longer lines in Python scripts 2017-02-14 21:17:32 -08:00
.gitignore reduce diff 2019-12-24 08:58:27 -08:00
app_test.go fix description of subcommand more consistent 2020-01-28 17:31:02 +09:00
app.go remove unused code 2019-12-31 16:36:01 +01:00
args.go add is set method to flag interface - refer #294 2019-09-15 18:46:52 +05:30
build.go try install markdown-toc globally 2020-01-13 10:59:32 +05:30
category.go amend comments 2019-12-12 21:29:09 +00:00
cli.go Merge master @1.22.1 with v2 2019-09-13 05:17:24 +05:30
CODE_OF_CONDUCT.md Adjust contribution and maintainer prose per current reality 2018-02-20 12:40:43 -05:00
command_test.go reduce stdout logs in tests 2019-12-29 17:00:19 +01:00
command.go Check for parsing errors within parse.go:parseIter 2019-11-27 11:42:57 -05:00
context_test.go add a fix 2019-12-24 08:55:31 -08:00
context.go revert back to correct formatting 2020-01-25 23:27:56 +05:30
docs_test.go Merge branch 'master' into github-actions-windows 2020-01-13 11:29:49 +05:30
docs.go Use VisibleFlags during doc generation 2019-12-19 08:38:43 -05:00
errors_test.go Back out the testify/assert addition 😅 2017-08-04 12:43:16 -04:00
errors.go amend comments 2019-12-12 21:29:09 +00:00
fish_test.go Merge master @1.22.1 with v2 2019-09-13 05:17:24 +05:30
fish.go Fix test cases for context, docs, errors, fish, flags and funcs 2019-09-15 11:01:20 +05:30
flag_bool.go refactor flag names - make it more explicitly 2019-12-29 08:58:12 +01:00
flag_duration.go refactor flag names - make it more explicitly 2019-12-29 08:58:12 +01:00
flag_float64_slice.go Fix possible panics in slice type assertion 2020-01-22 12:30:31 +01:00
flag_float64.go refactor flag names - make it more explicitly 2019-12-29 08:58:12 +01:00
flag_generic.go refactor flag names - make it more explicitly 2019-12-29 08:58:12 +01:00
flag_int64_slice.go Fix possible panics in slice type assertion 2020-01-22 12:30:31 +01:00
flag_int64.go refactor flag names - make it more explicitly 2019-12-29 08:58:12 +01:00
flag_int_slice.go Fix possible panics in slice type assertion 2020-01-22 12:30:31 +01:00
flag_int.go refactor flag names - make it more explicitly 2019-12-29 08:58:12 +01:00
flag_path.go refactor flag names - make it more explicitly 2019-12-29 08:58:12 +01:00
flag_string_slice.go Fix possible panics in slice type assertion 2020-01-22 12:30:31 +01:00
flag_string.go refactor flag names - make it more explicitly 2019-12-29 08:58:12 +01:00
flag_test.go goimports - fix code format 2019-12-30 10:41:15 +01:00
flag_timestamp.go refactor flag names - make it more explicitly 2019-12-29 08:58:12 +01:00
flag_uint64.go refactor flag names - make it more explicitly 2019-12-29 08:58:12 +01:00
flag_uint.go refactor flag names - make it more explicitly 2019-12-29 08:58:12 +01:00
flag.go refactor flag names - make it more explicitly 2019-12-29 08:58:12 +01:00
funcs.go Fix test cases for context, docs, errors, fish, flags and funcs 2019-09-15 11:01:20 +05:30
go.mod Merge master @1.22.1 with v2 2019-09-13 05:17:24 +05:30
go.sum Merge master @1.22.1 with v2 2019-09-13 05:17:24 +05:30
help_test.go Merge branch 'clean-help-printer' into help-printer-v2 2019-10-20 23:41:33 -04:00
help.go fix some golint errors show in go report card 2019-12-12 21:24:43 +00:00
helpers_test.go remove unused code 2019-12-31 16:36:01 +01:00
LICENSE Update license text 2016-06-21 12:52:25 -04:00
parse.go revert testing change 2019-11-27 20:37:23 -08:00
README.md Update README.md 2020-01-18 14:10:20 -08:00
sort_test.go Merge master @1.22.1 with v2 2019-09-13 05:17:24 +05:30
sort.go Merge master @1.22.1 with v2 2019-09-13 05:17:24 +05:30
template.go fix description of subcommand more consistent 2020-01-28 17:31:02 +09:00

cli

GoDoc codebeat 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 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.

Installation

Make sure you have a working Go environment. Go version 1.11+ is supported. See the install instructions for Go.

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

Using v2 releases

$ GO111MODULE=on go get github.com/urfave/cli/v2
...
import (
  "github.com/urfave/cli/v2" // imports as package "cli"
)
...

Using v1 releases

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

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.