Sourced from github.com/spf13/cobra's releases.

v1.6.0

Summer 2022 Release

Some exciting changes make their way to Cobra! Command completions continue to get better and better (including adding --help and --version automatic flags to the completions list). Grouping is now possible in your help output as well! And you can now use the OnFinalize method to cleanup things when all "work" is done. Checkout the full changelog below:

---

Features 🌠

• Add groups for commands in help: @​aawsome @​marckhouzam #1003
• Support for case-insensitive command names: @​YuviGold #1802
• Expose ValidateRequiredFlags and ValidateFlagGroups: @​skeetwu #1760
• Add --version flag to help output: @​fnickels #1707
• Add --help and --version flag in completions: @​marckhouzam #1813
• Add OnFinalize method: @​yann-soubeyrand #1788
• Allow user to add completion for powershell alias: @​marckhouzam #1621
• Make InitDefaultcompletionCmd public: @​gssbzn #1467

Deprecation 👎🏼

• ExactValidArgs is deprecated (but not being removed entirely). This is abit nuanced, so checkout #1643 for further information and the updated user_guide.md on how this may affect you (and how you can take advantage of the correct behavior in the validators): @​umarcor #1643

Bug fixes 🐛

• Fix (bash-v2) activeHelp length check syntax: @​scop #1762
• Fix correct command path in see_also for yaml documentation: @​zregvart #1771
• Fix showing flags that shadow parent persistent flag in child help messaging: @​brianpursley #1776

Dependencies 🗳️

• Upgrade to use gopkg.in/yaml.v3: @​tklauser #1766

Testing 🤔

• Test on Golang 1.19: @​umarcor & @​jpmcb #1782
• Renamed powershell completion tests: @​marckhouzam #1803
• Use action/setup-go cache: @​umarcor #1783
• Add workflow_dispatch to CI actions: @​umarcor #1387
• Add minimum GitHub token permissions for workflows: @​varunsh-coder #1792

Docs ✏️

• Fixup spelling for GitHub CLI: @​eltociear #1744
• Clarify SetContext documentation: @​katexochen #1748
• Instruct user to go install for binary: @​marckhouzam #1726
• User guide cleanup: @​marckhouzam #1656
• Document option to hide the default completion command: @​marckhouzam #1779

Misc 💭

• Add KubeVirt, CloudQuery, Cilium, Okteto, Zitadel, Allero to projects using cobra: @​maiqueb #1741, @​yevgenypats #1742, @​tklauser #1745, @​jLopezbarb #1759, @​fforootd #1772, @​dimabru #1819
• Use correct stale action exempt yaml keys: @​jpmcb #1800
• Add missing license headers: @​umarcor #1809

Note: Per #1804, we will be moving away from "seasonal" releases and doing more generic point release targets. Continue to track the milestones and issues in the spf13/cobra GitHub repository for more information!

Great work everyone! Cobra would never be possible without your contributions! 🐍

... (truncated)

• 8607918 feat: make InitDefaultCompletionCmd public (#1467)
• 2169adb Add groups for commands in help (#1003)
• 212ea40 Include --help and --version flag in completion (#1813)
• d4040ad Allow user to add completion for powershell alias (#1621)
• 23fc5e0 ci: add minimum GitHub token permissions for workflows (#1792)
• 93d1913 Add OnFinalize method (#1788)
• 07034fe build(deps): bump actions/stale from 5 to 6 (#1815)
• 3dc9761 Add allero to list of projects using cobra (#1819)
• 7039e1f Add '--version' flag to Help output (#1707)
• fce8d8a Expose ValidateRequiredFlags and ValidateFlagGroups (#1760)
• Additional commits viewable in compare 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)

Sourced from github.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 Help spf13/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 a group. Shout out to our newest maintainer @​johnSchnake for this! spf13/cobra#1654 Let's say you have a username flag that MUST be partnered with a password 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 the MarkFlagsMutuallyExclusive(string, string ... ) command API. Refer to our user guide documentation for further info!

Completions 👀

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

Documentation 📝

• Fixed typos in completions docs - @​cuishuang spf13/cobra#1625
• Removed CHANGELOG.md as it isn't updated - @​johnSchnake spf13/cobra#1634
• Minor typo fix in shell_completion.md - @​danieldn spf13/cobra#1678
• Changed branch name in the cobra generator link to 'main' - @​skywalker2909 spf13/cobra#1645
• Fix Command.Context comment by @​katexochen in spf13/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 in compare 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)

Sourced from github.com/spf13/cobra's releases.

v1.4.0

Winter 2022 Release ❄️

Another season, another release!

Goodbye viper! 🐍 🚀

The core Cobra library no longer requires Viper and all of its indirect dependencies. This means that Cobra's dependency tree has been drastically thinned! The Viper dependency was included because of the cobra CLI generation tool. This tool has migrated to spf13/cobra-cli.

It's pretty unlikely you were importing and using the bootstrapping CLI tool as part of your application (after all, it's just a tool to get going with core cobra).

But if you were, replace occurrences of

"github.com/spf13/cobra/cobra"

with

"github.com/spf13/cobra-cli"

And in your go.mod, you'll want to also include this dependency:

github.com/spf13/cobra-cli v1.3.0

Again, the maintainers do not anticipate this being a breaking change to users of the core cobra library, so minimal work should be required for users to integrate with this new release. Moreover, this means the dependency tree for your application using Cobra should no longer require dependencies that were inherited from Viper. Huzzah! 🥳

If you'd like to read more

• issue: spf13/cobra#1597
• PR: spf13/cobra#1604

Documentation 📝

• Update Go Doc link and badge in README: spf13/cobra#1593
• Fix to install command, now targets @latest: spf13/cobra#1576
• Added MAINTAINERS file: spf13/cobra#1545

Other 💭

• Bumped license year to 2022 in golden files: spf13/cobra#1575
• Added Pixie to projects: spf13/cobra#1581
• Updated labeler for new labeling scheme: spf13/cobra#1613 & syntax fix: spf13/cobra#1624

Shoutout to our awesome contributors helping to make this cobra release possible!! @​spf13 @​marckhouzam @​johnSchnake @​jpmcb @​liggitt @​umarcor @​hiljusti @​marians @​shyim @​htroisi

Sourced from github.com/spf13/cobra's changelog.

Cobra Changelog

v1.1.3

• Fix: release-branch.cobra1.1 only: Revert "Deprecate Go < 1.14" to maintain backward compatibility

v1.1.2

Notable Changes

• Bump license year to 2021 in golden files (#1309) @​Bowbaq
• Enhance PowerShell completion with custom comp (#1208) @​Luap99
• Update gopkg.in/yaml.v2 to v2.4.0: The previous breaking change in yaml.v2 v2.3.0 has been reverted, see go-yaml/yaml#670
• Documentation readability improvements (#1228 etc.) @​zaataylor etc.
• Use golangci-lint: Repair warnings and errors resulting from linting (#1044) @​umarcor

v1.1.1

• Fix: yaml.v2 2.3.0 contained a unintended breaking change. This release reverts to yaml.v2 v2.2.8 which has recent critical CVE fixes, but does not have the breaking changes. See spf13/cobra#1259 for context.
• Fix: correct internal formatting for go-md2man v2 (which caused man page generation to be broken). See spf13/cobra#1049 for context.

v1.1.0

Notable Changes

• Extend Go completions and revamp zsh comp (#1070)
• Fix man page doc generation - no auto generated tag when cmd.DisableAutoGenTag = true (#1104) @​jpmcb
• Add completion for help command (#1136)
• Complete subcommands when TraverseChildren is set (#1171)
• Fix stderr printing functions (#894)
• fix: fish output redirection (#1247)

v1.0.0

Announcing v1.0.0 of Cobra. 🎉

Notable Changes

• Fish completion (including support for Go custom completion) @​marckhouzam
• API (urgent): Rename BashCompDirectives to ShellCompDirectives @​marckhouzam
• Remove/replace SetOutput on Command - deprecated @​jpmcb
• add support for autolabel stale PR @​xchapter7x
• Add Labeler Actions @​xchapter7x
• Custom completions coded in Go (instead of Bash) @​marckhouzam
• Partial Revert of #922 @​jharshman
• Add Makefile to project @​jharshman
• Correct documentation for InOrStdin @​desponda
• Apply formatting to templates @​jharshman
• Revert change so help is printed on stdout again @​marckhouzam
• Update md2man to v2.0.0 @​pdf
• update viper to v1.4.0 @​umarcor

... (truncated)

• 5b2b9e9 Removes viper dependency by removing cobra/ CLI tool (#1604)
• 9369465 labeler: fix syntax
• e1b831e Updates labeler for new labels (#1613)
• 8267283 Add MAINTAINERS file (alphabetical order) (#1545)
• 6d2dc43 Add Pixie to projects. (#1581)
• a599632 Fix install command (#1576)
• 7cabfeb Update Go Doc link and badge (#1593)
• e04ec72 Bump license year to 2022 in golden files (#1575)
• cb9d7b1 Bump github.com/spf13/viper from 1.10.0 to 1.10.1 (#1567)
• See full diff in compare 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)

Sourced from github.com/spf13/cobra's releases.

v1.3.0 - The Fall 2021 release 🍁

Completion fixes & enhancements 💇🏼

In v1.2.0, we introduced a new model for completions. Thanks to everyone for trying it, giving feedback, and providing numerous fixes! Continue to work with the new model as the old one (as noted in code comments) will be deprecated in a coming release.

• DisableFlagParsing now triggers custom completions for flag names #1161
• Fixed unbound variables in bash completions causing edge case errors #1321
• help completion formatting improvements & fixes #1444
• All completions now follow the help example: short desc are now capitalized and removes extra spacing from long description #1455
• Typo fixes in bash & zsh completions #1459
• Fixed mixed tab/spaces indentation in completion scripts. Now just 4 spaces #1473
• Support for different bash completion options. Bash completions v2 supports descriptions and requires descriptions to be removed for menu-complete, menu-complete-backward and insert-completions. These descriptions are now purposefully removed in support of this model. #1509
• Fix for invalid shell completions when using ~/.cobra.yaml. Log message Using config file: ~/.cobra.yaml now printed to stderr #1510
• Removes unnecessary trailing spaces from completion command descriptions #1520
• Option to hid default completion command #1541
• Remove __complete command for programs without subcommands #1563

Generator changes ⚙️

Thanks to @​spf13 for providing a number of changes to the Cobra generator tool, streamlining it for new users!

• The Cobra generator now won't automatically include Viper and cleans up a number of unused imports when not using Viper.
• The Cobra generator's default license is now none
• The Cobra generator now works with Go modules
• Documentation to reflect these changes

New Features ⭐

• License can be specified by their SPDX identifiers #1159
• MatchAll allows combining several PositionalArgs to work in concert. This now allows for enabling composing PositionalArgs #896

Bug Fixes 🐛

• Fixed multiple error message from cobra init boilerplates #1463 #1552 #1557

Testing 👀

• Now testing golang 1.16.x and 1.17.x in CI #1425
• Fix for running diff test to ignore CR for windows #949
• Added helper functions and reduced code reproduction in args_test #1426
• Now using official golangci-lint github action #1477

Security 🔏

• Added GitHub dependabot #1427
• Now using Viper v1.10.0
  • There is a known CVE in an indirect dependency from viper: spf13/cobra#1538. This will be patched in a future release

Documentation 📝

• Multiple projects added to the projects_using_cobra.md file: #1377 #1501 #1454
• Removed ToC from main readme file as it is now automagically displayed by GitHub #1429
• Documentation correct for when the --author flag is specified #1009
• shell_completions.md has an easier to use snippet for copying and pasting shell completions #1372

... (truncated)

• 178edbb Bump github.com/spf13/viper from 1.9.0 to 1.10.0 (#1561)
• 9054739 Remove __complete cmd for program without subcmds (#1563)
• 19c9c74 Always include the os package import when generating the root command (#1557)
• 01e05b8 Bump github.com/spf13/viper from 1.8.1 to 1.9.0 (#1554)
• 36bff0a fix root.go.golden (#1552)
• 1854bb5 Fix some typos (mostly found by codespell) (#1514)
• ff2c55e chore(ci): use golangci-lint-action (#1477)
• 1beb476 fix: Duplicate error message from cobra init boilerplates (#1463)
• 6f84ef4 Provide option to hide default 'completion' cmd (#1541)
• ee75a2b Remove trailing spaces from bash completion command description (#1520)
• Additional commits viewable in compare 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)

Sourced from github.com/spf13/cobra's releases.

v1.6.1

Bug fixes 🐛

• Fixes a panic when AddGroup isn't called before AddCommand(my-sub-command) is executed. This can happen within more complex cobra file structures that have many different inits to be executed. Now, the check for groups has been moved to ExecuteC and provides more flexibility when working with grouped commands - @​marckhouzam (and shout out to @​aawsome, @​andig and @​KINGSABRI for a deep investigation into this! 👏🏼)

v1.6.0

Summer 2022 Release

Some exciting changes make their way to Cobra! Command completions continue to get better and better (including adding --help and --version automatic flags to the completions list). Grouping is now possible in your help output as well! And you can now use the OnFinalize method to cleanup things when all "work" is done. Checkout the full changelog below:

---

Features 🌠

• Add groups for commands in help: @​aawsome @​marckhouzam #1003
• Support for case-insensitive command names: @​YuviGold #1802
• Expose ValidateRequiredFlags and ValidateFlagGroups: @​skeetwu #1760
• Add --version flag to help output: @​fnickels #1707
• Add --help and --version flag in completions: @​marckhouzam #1813
• Add OnFinalize method: @​yann-soubeyrand #1788
• Allow user to add completion for powershell alias: @​marckhouzam #1621
• Make InitDefaultcompletionCmd public: @​gssbzn #1467

Deprecation 👎🏼

• ExactValidArgs is deprecated (but not being removed entirely). This is abit nuanced, so checkout #1643 for further information and the updated user_guide.md on how this may affect you (and how you can take advantage of the correct behavior in the validators): @​umarcor #1643

Bug fixes 🐛

• Fix (bash-v2) activeHelp length check syntax: @​scop #1762
• Fix correct command path in see_also for yaml documentation: @​zregvart #1771
• Fix showing flags that shadow parent persistent flag in child help messaging: @​brianpursley #1776

Dependencies 🗳️

• Upgrade to use gopkg.in/yaml.v3: @​tklauser #1766

Testing 🤔

• Test on Golang 1.19: @​umarcor & @​jpmcb #1782
• Renamed powershell completion tests: @​marckhouzam #1803
• Use action/setup-go cache: @​umarcor #1783
• Add workflow_dispatch to CI actions: @​umarcor #1387
• Add minimum GitHub token permissions for workflows: @​varunsh-coder #1792

Docs ✏️

• Fixup spelling for GitHub CLI: @​eltociear #1744
• Clarify SetContext documentation: @​katexochen #1748
• Instruct user to go install for binary: @​marckhouzam #1726
• User guide cleanup: @​marckhouzam #1656
• Document option to hide the default completion command: @​marckhouzam #1779

Misc 💭

• Add KubeVirt, CloudQuery, Cilium, Okteto, Zitadel, Allero to projects using cobra: @​maiqueb #1741, @​yevgenypats #1742, @​tklauser #1745, @​jLopezbarb #1759, @​fforootd #1772, @​dimabru #1819
• Use correct stale action exempt yaml keys: @​jpmcb #1800

... (truncated)

• b43be99 Check for group presence after full initialization (#1839) (#1841)
• 8607918 feat: make InitDefaultCompletionCmd public (#1467)
• 2169adb Add groups for commands in help (#1003)
• 212ea40 Include --help and --version flag in completion (#1813)
• d4040ad Allow user to add completion for powershell alias (#1621)
• 23fc5e0 ci: add minimum GitHub token permissions for workflows (#1792)
• 93d1913 Add OnFinalize method (#1788)
• 07034fe build(deps): bump actions/stale from 5 to 6 (#1815)
• 3dc9761 Add allero to list of projects using cobra (#1819)
• 7039e1f Add '--version' flag to Help output (#1707)
• Additional commits viewable in compare 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)