Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
avirtopeanu-ionos authored Nov 16, 2023
1 parent c579841 commit 42bd7e3
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
# Cobra-Prompt Plus (Comptplus)

Comptplus is a fork of [Cobra Prompt](https://github.com/stromland/cobra-prompt) with added features:
- Automatic Flag Value Completion: Extracts possible flag values and recommends them to the user.
- Works with descriptions registered via `RegisterFlagCompletionFunc`
- This is only possible with Cobra 1.8.0 (specifically PRs [spf13/cobra#1943](https://github.com/spf13/cobra/pull/1943) and [spf13/cobra#2063](https://github.com/spf13/cobra/pull/2063))
- Flag descriptions are also added correctly (in Cobra `\t` is used to split the flag values vs. flag descriptions).
- Refactor to use some stateless funcs

## Original README below

-----

# Cobra-Prompt

Cobra-prompt makes every Cobra command and flag available for go-prompt.
Expand Down

0 comments on commit 42bd7e3

Please sign in to comment.