cobra

func AfterDash ¶ added in v0.8.0

func AfterDash(cmd *cobralib.Command) bool

AfterDash reports whether the native completion cursor follows a -- boundary. It is also available to callbacks registered directly with Cobra. Unlike ArgsLenAtDash, this is not affected by Cobra's probe parse of an extra --. This is a lexical check: a standalone -- used as a flag value also counts.

func CompletionCommand ¶

func CompletionCommand(
	parent *cobralib.Command,
	genFunc func() *complete.Generator,
) *cobralib.Command

CompletionCommand returns a cobra subcommand that replaces cobra's built-in "completion" command with one powered by clib. It disables cobra's default completion subcommand on parent and generates scripts via complete.Generator.

The genFunc is called at run time to build the generator, so the full command tree is available.

Usage:

cmd.AddCommand(clib.CompletionCommand(cmd, func() *complete.Generator {
    gen := complete.NewGenerator("myapp").FromFlags(clib.FlagMeta(cmd))
    gen.Subs = clib.Subcommands(cmd)
    return gen
}))

func Extend ¶

func Extend(flag *pflag.Flag, extra FlagExtra)

Extend attaches clib metadata to a pflag.Flag.

cobracli.Extend(f.Lookup("repo"), cobracli.FlagExtra{
	Group:       "Filters",
	Placeholder: "repo",
	Complete:    "predictor=repo",
})

func ExtendCommand ¶ added in v0.7.4

func ExtendCommand(cmd *cobralib.Command, extra CommandExtra)

ExtendCommand attaches clib metadata to a cobra command.

func FlagMeta ¶

func FlagMeta(cmd *cobralib.Command) []complete.FlagMeta

FlagMeta extracts completion metadata from a cobra command's flags. It reads pflag properties and clib extras from all flags on the command.

func HelpFunc ¶

func HelpFunc(
	r *help.Renderer,
	sections func(cmd *cobralib.Command) []help.Section,
	opts ...help.Option,
) func(*cobralib.Command, []string)

HelpFunc returns a cobra-compatible help function that renders themed help. The sections callback receives the command and returns sections to render. By default, the description blurb and examples are hidden on -h and shown on --help (examples last); pass help.WithAlwaysShowDescription and/or help.WithAlwaysShowExamples to disable this.

func RegisterCompletions ¶ added in v0.8.0

func RegisterCompletions(
	root *cobralib.Command,
	opts ...CompletionOption,
) (*complete.Generator, error)

RegisterCompletions bridges clib metadata to Cobra's native completion API. Call it after constructing the command tree and registering native callbacks. Existing callbacks and ValidArgs are preserved. The returned generator uses native Bash, Fish and Zsh clients; other shells retain their legacy clients. Keep handling --@complete requests for previously installed scripts.

The bridge captures completion words in the root's persistent pre-run hook. Existing hooks still run; use complete.IsRequest to bypass application setup during completion. Register again if commands are added later.

func Sections ¶

func Sections(cmd *cobralib.Command) []help.Section

Sections builds usage, aliases, examples, and grouped command/flag sections. Command groups combine native titles with CommandExtra.Group; see help.BuildCommandSections.

func SectionsWithOptions ¶

func SectionsWithOptions(opts ...SectionsOption) func(*cobralib.Command) []help.Section

SectionsWithOptions builds help sections with the given options.

func Subcommands ¶

func Subcommands(cmd *cobralib.Command) []complete.SubSpec

Subcommands extracts subcommand completion specs from a cobra command tree. Each visible subcommand produces a SubSpec with its local flags (excluding the built-in --help flag).