Skip to content

Commit 51002c2

Browse files
committed
Update README.md
1 parent 5a458be commit 51002c2

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
[![GoDoc](https://godoc.org/github.com/mfridman/cli?status.svg)](https://godoc.org/github.com/mfridman/cli)
44
[![CI](https://github.com/mfridman/cli/actions/workflows/ci.yaml/badge.svg)](https://github.com/mfridman/cli/actions/workflows/ci.yaml)
5-
[![Go Report Card](https://goreportcard.com/badge/github.com/mfridman/cli)](https://goreportcard.com/report/github.com/mfridman/cli)
5+
[![Go Report
6+
Card](https://goreportcard.com/badge/github.com/mfridman/cli)](https://goreportcard.com/report/github.com/mfridman/cli)
67

78
A lightweight framework for building Go CLI applications with nested subcommands.
89

@@ -12,12 +13,15 @@ library requires flags before arguments.
1213

1314
## Features
1415

15-
- **Nested Commands**: Build hierarchical command structures (like `git remote add`)
16-
- **Flexible Flag Parsing**: Supports flags and arguments in any order
17-
- **Inherited Flags**: Child commands can access parent flags
18-
- **Type-Safe Flags**: Type-inferred flag accessors
19-
- **Built-in Help**: Automatic help text generation
20-
- **Auto Suggestions**: Suggests similar commands when users make typos
16+
- Nested subcommands for organizing complex CLIs
17+
- Flexible flag parsing, allowing flags anywhere on the CLI
18+
- Subcommands inherit flags from parent commands
19+
- Type-safe flag access
20+
- Automatic generation of help text and usage information
21+
- Suggestions for misspelled or incomplete commands
22+
23+
And that's it! It's the bare minimum to build a CLI application in Go while leveraging the standard
24+
library's `flag` package.
2125

2226
## Installation
2327

0 commit comments

Comments
 (0)