$ show spf13/cobra
Cobra is a Go library for building command-line interfaces (CLIs). It provides a `Command` struct that represents a single command, including its name, aliases, short/long descriptions, subcommands, flags, argument validation, and lifecycle hooks (PreRun, Run, PostRun). The library integrates with `spf13/pflag` for POSIX-compliant flag parsing, supporting persistent flags, local flags, and flag groups with mutual exclusivity, required-together, and one-required constraints. Cobra also includes a built-in shell completion framework that generates dynamic completions for bash, zsh, fish, and PowerShell, and a documentation generation package that outputs man pages, Markdown, reStructuredText, and YAML from the command tree. Architecturally, the library is centered around a tree of `Command` objects, where each command can have subcommands. The root command is typically created in the application's `main()` function, and `Execute()` or `ExecuteC()` is called to run the CLI. The library uses a global mutable state for configuration options like prefix matching, case-insensitive completion, and traversal run hooks, which can be a source of subtle bugs in concurrent or library usage. Key entry points include `Command.Execute()`, `Command.AddCommand()`, `Command.Flags()`, `Command.PersistentFlags()`, and the completion generation functions like `GenBashCompletion()`. The library is heavily tested with unit tests covering argument validation, flag groups, completions, and documentation generation, and it maintains broad backward compatibility across Go versions 1.17–1.24. Cobra is designed for reuse; its argument validators (`args.go`), flag group helpers (`flag_groups.go`), and completion directives (`completions.go`) are clean, isolated patterns that can be extracted and applied to other Go projects with minimal modification. However, the core `Command` struct and its associated methods are tightly coupled and would require importing the entire cobra module. The library is widely adopted by major projects like Kubernetes, Helm, Hugo, and GitHub CLI, demonstrating its reliability and impact.
The LLM identified 2 files worth highlighting for reuse:
Provides functions `MarkFlagsRequiredTogether`, `MarkFlagsOneRequired`, and `MarkFlagsMutuallyExclusive` that allow CLI developers to define complex relationships between flags. The implementation is self-contained (only depends on `pflag` and internal cobra helpers) and demonstrates a clean, additive design for flag validation that can be extracted into any Go CLI project. The code handles edge cases like flag aliases and persistent flags, and automatically adjusts shell completion suggestions when conflicts are detected.
Defines a set of composable argument validators (`NoArgs`, `OnlyValidArgs`, `MinimumNArgs`, `ExactArgs`, `RangeArgs`, `MatchAll`, etc.) that return a single `Args` type. The `MatchAll` function enables combining multiple validators with logical AND, a pattern that is highly reusable and demonstrates non-obvious skill in building extensible validation chains. Each validator is a pure function, making the module trivially extractable into any Go project that needs positional argument validation.