Sourced fromgithub.com/spf13/cobra's releases.

v1.5.0

Spring 2022 Release 🌥️

Hello everyone! Welcome to another release of cobra. Completions continue to get better and better. This release adds a few really cool new features. We also continue to patch versions of our dependencies as they become available via dependabot. Happy coding!

Active help 👐🏼

Shout out to@​marckhouzam for a big value add: Active Helpspf13/cobra#1482. With active help, a program can provide some inline warnings or hints for users as they hit tab. Now, your CLIs can be even more intuitive to use!

Currently active help is only supported for bash V2 and zsh. Marc wrote a whole guide on how to do this, so make sure to give it a good read to learn how you can add this to your cobra code!https://github.com/spf13/cobra/blob/master/active_help.md

Group flags 🧑🏼‍🤝‍🧑🏼

Cobra now has the ability to mark flags as required or exclusive as agroup. Shout out to our newest maintainer@​johnSchnake for this!spf13/cobra#1654 Let's say you have ausername flag thatMUST be partnered with apassword flag. Well, now, you can enforce those as being required together:

rootCmd.Flags().StringVarP(&u,"username","u","","Username (required if password is set)")rootCmd.Flags().StringVarP(&pw,"password","p","","Password (required if username is set)")rootCmd.MarkFlagsRequiredTogether("username","password")

Flags may also be marked as "mutally exclusive" with theMarkFlagsMutuallyExclusive(string, string ... ) command API. Refer to ouruser guide documentation for further info!

Completions 👀

• Add backwards-compatibility tests for legacyArgs() by@​marckhouzam inspf13/cobra#1547
• feat: Add how to load completions in your current zsh session by@​ondrejsika inspf13/cobra#1608
• Introduce FixedCompletions by@​emersion inspf13/cobra#1574
• Add shell completion to flag groups by@​marckhouzam inspf13/cobra#1659
• Modify brew prefix path in macOS system by@​imxw inspf13/cobra#1719
• perf(bash-v2): use backslash escape string expansion for tab by@​scop inspf13/cobra#1682
• style(bash-v2): out is not an array variable, do not refer to it as such by@​scop inspf13/cobra#1681
• perf(bash-v2): standard completion optimizations by@​scop inspf13/cobra#1683
• style(bash): out is not an array variable, do not refer to it as such by@​scop inspf13/cobra#1684
• perf(bash-v2): short-circuit descriptionless candidate lists by@​scop inspf13/cobra#1686
• perf(bash-v2): speed up filtering entries with descriptions by@​scop inspf13/cobra#1689
• perf(bash-v2): speed up filtering menu-complete descriptions by@​scop inspf13/cobra#1692
• fix(bash-v2): skip empty completions when filtering descriptions by@​scop inspf13/cobra#1691
• perf(bash-v2): read directly to COMPREPLY on descriptionless short circuit by@​scop inspf13/cobra#1700
• fix: Don't complete _command on zsh by@​twpayne inspf13/cobra#1690
• Improve fish_completions code quality by@​t29kida inspf13/cobra#1515
• Fix handling of descriptions for bash v3 by@​marckhouzam inspf13/cobra#1735
• undefined or nil Args default to ArbitraryArgs by@​umarcor inspf13/cobra#1612
• Add Command.SetContext by@​joshcarp inspf13/cobra#1551
• Wrap printf tab with quotes by@​PapaCharlie inspf13/cobra#1665

Documentation 📝

• Fixed typos in completions docs -@​cuishuangspf13/cobra#1625
• RemovedCHANGELOG.md as it isn't updated -@​johnSchnakespf13/cobra#1634
• Minor typo fix inshell_completion.md -@​danieldnspf13/cobra#1678
• Changed branch name in the cobra generator link to 'main' -@​skywalker2909spf13/cobra#1645
• Fix Command.Context comment by@​katexochen inspf13/cobra#1639

... (truncated)

• 06b06a9 Bump golangci/golangci-lint-action from 3.1.0 to 3.2.0 (#1697)
• 5f2ec3c Update shell completion to respect flag groups (#1659)
• b9ca594 use errors.Is() to check for errors (#1730)
• ea94a3d undefined or nil Args default to ArbitraryArgs (#1612)
• 7c9831d Fix handling of descriptions for bash v3 (#1735)
• ed7bb9d Add unit test for fish completion (#1515)
• f464d6c Add Active Help support (#1482)
• 7dc8b00 Bump actions/setup-go from 2 to 3 (#1660)
• 87ea180 Modify brew prefix path in macOS system (#1719)
• ca8e3c2 Add Pulumi as a project using cobra (#1720)
• Additional commits viewable incompare view

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)