Skip to content

fix: allow CLI extensions to opt in to self-documented help #6708

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
pkey wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix: allow CLI extensions to opt in to self-documented help #6708

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions cliv2/cmd/cliv2/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,8 @@ func createCommandsForWorkflows(rootCommand *cobra.Command, engine workflow.Engi
// to preserve backwards compatibility we will need to relax flag validation
parentCommand.FParseErrWhitelist.UnknownFlags = true
parentCommand.Aliases = []string{"mcp-scan"}
case "redteam":
parentCommand.Annotations = map[string]string{"self-documented": "true"}
}
}
}
Expand All @@ -444,8 +446,6 @@ func prepareRootCommand() *cobra.Command {
},
}

// help for all commands is handled by the legacy cli
// TODO: discuss how to move help to extensions
helpCommand := cobra.Command{
Use: "help",
RunE: help,
Expand All @@ -457,8 +457,17 @@ func prepareRootCommand() *cobra.Command {
rootCommand.SilenceUsage = true
rootCommand.FParseErrWhitelist.UnknownFlags = true

// ensure that help and usage information comes from the legacy cli instead of cobra's default help
rootCommand.SetHelpFunc(func(c *cobra.Command, args []string) { _ = help(c, args) })
// Extensions can opt in to handle their own help by setting the "self-documented" annotation.
// When set, Cobra renders help from the command's flagset and Short/Long fields.
// Commands without the annotation fall back to the legacy CLI help.
rootCommand.SetHelpFunc(func(c *cobra.Command, args []string) {
if c.Annotations["self-documented"] == "true" {
c.InitDefaultHelpFlag()
_ = c.Usage()
} else {
_ = help(c, args)
}
})
rootCommand.SetHelpCommand(&helpCommand)
rootCommand.PersistentFlags().AddFlagSet(getGlobalFLags())

Expand Down
Loading