search

package

v1.261022.0 Latest Latest Go to latest Published: Oct 22, 2026 License: MIT Imports: 12 Imported by: 0

Documentation ¶

Index ¶

func SearchCommand(commands func() []*ffcli.Command) *ffcli.Command
type SearchResponse
- func SearchCommands(commands []*ffcli.Command, query string, limit int) SearchResponse
type SearchResult

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func SearchCommand ¶

func SearchCommand(commands func() []*ffcli.Command) *ffcli.Command

SearchCommand returns the command-discovery search command.

Types ¶

type SearchResponse ¶

type SearchResponse struct {
	Query   string         `json:"query"`
	Count   int            `json:"count"`
	Results []SearchResult `json:"results"`
}

SearchResponse is the machine-readable output for command discovery.

func SearchCommands ¶

func SearchCommands(commands []*ffcli.Command, query string, limit int) SearchResponse

SearchCommands searches a command tree and returns ranked results.

type SearchResult ¶

type SearchResult struct {
	Command  string   `json:"command"`
	Summary  string   `json:"summary"`
	Usage    string   `json:"usage,omitempty"`
	Score    int      `json:"score"`
	Matched  []string `json:"matched"`
	Examples []string `json:"examples,omitempty"`
}

SearchResult describes a matching CLI command.

Source Files ¶

View all Source files

search.go

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