-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7b574e0
commit c9d70a8
Showing
1 changed file
with
26 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,44 @@ | ||
# Welcome to urfave/cli | ||
|
||
[![Run Tests](https://github.com/urfave/cli/actions/workflows/cli.yml/badge.svg)](https://github.com/urfave/cli/actions/workflows/cli.yml) | ||
[![Go Reference](https://pkg.go.dev/badge/github.com/urfave/cli/v3.svg)](https://pkg.go.dev/github.com/urfave/cli/v3) | ||
[![Go Report Card](https://goreportcard.com/badge/github.com/urfave/cli/v3)](https://goreportcard.com/report/github.com/urfave/cli/v3) | ||
[![codecov](https://codecov.io/gh/urfave/cli/branch/main/graph/badge.svg?token=t9YGWLh05g)](https://codecov.io/gh/urfave/cli) | ||
[![Go Reference][goreference_badge]][goreference_link] | ||
[![Go Report Card][goreportcard_badge]][goreportcard_link] | ||
[![codecov][codecov_badge]][codecov_link] | ||
[![Tests status][test_badge]][test_link] | ||
|
||
urfave/cli is a **declarative**, simple, fast, and fun package for building command line tools in Go featuring: | ||
urfave/cli is a **declarative**, simple, fast, and fun package for building | ||
command line tools in Go featuring: | ||
|
||
- commands and subcommands with alias and prefix match support | ||
- flexible and permissive help system | ||
- dynamic shell completion for `bash`, `zsh`, `fish`, and `powershell` | ||
- `man` and markdown format documentation generation | ||
- input flags for simple types, slices of simple types, time, duration, and others | ||
- compound short flag support (`-a` `-b` `-c` :arrow_right: `-abc`) | ||
- compound short flag support (`-a` `-b` `-c` can be shortened to `-abc`) | ||
- input lookup from: | ||
- environment variables | ||
- plain text files | ||
- [structured file formats supported via the `urfave/cli-altsrc` package](https://github.com/urfave/cli-altsrc) | ||
- environment variables | ||
- plain text files | ||
- [structured file formats supported via the `urfave/cli-altsrc` package](https://github.com/urfave/cli-altsrc) | ||
|
||
## Documentation | ||
|
||
More documentation is available in [`./docs`](./docs) or the hosted documentation site published from the latest release | ||
at <https://cli.urfave.org>. | ||
See the hosted documentation website at <https://cli.urfave.org>. Contents of | ||
this website are built from the [`./docs`](./docs) directory. | ||
|
||
## Q&A | ||
## Q&A | ||
|
||
Please check the [Q&A discussions](https://github.com/urfave/cli/discussions/categories/q-a) or [ask a new | ||
question](https://github.com/urfave/cli/discussions/new?category=q-a). | ||
Please check the [Q&A discussions] or [ask a new question]. | ||
|
||
## License | ||
|
||
See [`LICENSE`](./LICENSE) | ||
See [`LICENSE`](./LICENSE). | ||
|
||
[Q&A discussions]: https://github.com/urfave/cli/discussions/categories/q-a | ||
[ask a new question]: https://github.com/urfave/cli/discussions/new?category=q-a | ||
[test_badge]: https://github.com/urfave/cli/actions/workflows/test.yml/badge.svg | ||
[test_link]: https://github.com/urfave/cli/actions/workflows/test.yml | ||
[goreference_badge]: https://pkg.go.dev/badge/github.com/urfave/cli/v3.svg | ||
[goreference_link]: https://pkg.go.dev/github.com/urfave/cli/v3 | ||
[goreportcard_badge]: https://goreportcard.com/badge/github.com/urfave/cli/v3 | ||
[goreportcard_link]: https://goreportcard.com/report/github.com/urfave/cli/v3 | ||
[codecov_badge]: https://codecov.io/gh/urfave/cli/branch/main/graph/badge.svg?token=t9YGWLh05g | ||
[codecov_link]: https://codecov.io/gh/urfave/cli |