help

package

v0.6.0 Latest Latest Go to latest Published: Jun 4, 2026 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

gitcode.com/gitcode-cli/cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package help implements the help command with search and discovery features.

Index ¶

func CollectTopics(root *cobra.Command) []string
func NewCmdHelp(root *cobra.Command) *cobra.Command
func RegisterTopicEnum(cmd *cobra.Command, flagName string)
func SetTopicAnnotation(cmd *cobra.Command, topic string)
type CommandInfo
type HelpOptions

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CollectTopics ¶

func CollectTopics(root *cobra.Command) []string

CollectTopics returns all unique topics defined in the command tree.

func NewCmdHelp ¶

func NewCmdHelp(root *cobra.Command) *cobra.Command

NewCmdHelp creates the help command with search and discovery features.

func RegisterTopicEnum ¶

func RegisterTopicEnum(cmd *cobra.Command, flagName string)

RegisterTopicEnum registers the standard topics as enum values for --topic flag.

func SetTopicAnnotation ¶

func SetTopicAnnotation(cmd *cobra.Command, topic string)

SetTopicAnnotation adds a topic annotation to a command. Deprecated: Use cmdutil.SetTopicAnnotation instead.

Types ¶

type CommandInfo ¶

type CommandInfo struct {
	Path    string   // Full command path (e.g., "gc pr view")
	Name    string   // Command name (e.g., "view")
	Short   string   // Short description
	Topic   string   // Topic category (from annotation)
	Aliases []string // Command aliases
	Hidden  bool     // Whether command is hidden
}

CommandInfo holds metadata about a command for search and discovery.

func BuildIndex ¶

func BuildIndex(root *cobra.Command) []CommandInfo

BuildIndex traverses the command tree and builds a searchable index.

func FilterByTopic ¶

func FilterByTopic(index []CommandInfo, topic string) []CommandInfo

FilterByTopic returns commands belonging to a specific topic.

func Search ¶

func Search(index []CommandInfo, keyword string) []CommandInfo

Search finds commands matching the given keyword. Matches against path, name, short description, and aliases.

type HelpOptions ¶

type HelpOptions struct {
	Root   *cobra.Command
	Search string
	Topics bool
	Topic  string
	JSON   bool
}

Source Files ¶

help.go
search.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL