cmdcatalog

package

v0.182.6 Latest Latest Go to latest Published: Oct 6, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Details

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

Repository

github.com/sneat-dev/wb

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func NewCommands() *cobra.Command
func NewHelp(exitError func(int, string) error) *cobra.Command
func PrepareHelp(root *cobra.Command, args []string, ...)
func SetDiscoveryTerms(command *cobra.Command, terms string)
func UsageRecoveryHint(root *cobra.Command, args []string) string
func VisitPublic(root *cobra.Command, visit func(*cobra.Command))
type Catalog
type Entry

Constants ¶

View Source

const DiscoveryTermsAnnotation = "wb.dev/discovery-terms"

Variables ¶

This section is empty.

Functions ¶

func NewCommands ¶

func NewCommands() *cobra.Command

func NewHelp ¶

func NewHelp(exitError func(int, string) error) *cobra.Command

func PrepareHelp ¶

func PrepareHelp(root *cobra.Command, args []string, persistentFlagSupport map[string]map[string]bool, commandID func(*cobra.Command) string)

func SetDiscoveryTerms ¶

func SetDiscoveryTerms(command *cobra.Command, terms string)

func UsageRecoveryHint ¶

func UsageRecoveryHint(root *cobra.Command, args []string) string

func VisitPublic ¶

func VisitPublic(root *cobra.Command, visit func(*cobra.Command))

Types ¶

type Catalog ¶

type Catalog struct {
	SchemaVersion int     `json:"schema_version"`
	Query         string  `json:"query,omitempty"`
	Commands      []Entry `json:"commands"`
}

type Entry ¶

type Entry struct {
	Path           string   `json:"path"`
	Summary        string   `json:"summary"`
	Aliases        []string `json:"aliases,omitempty"`
	Examples       []string `json:"examples,omitempty"`
	DiscoveryTerms []string `json:"discovery_terms,omitempty"`
	Group          string   `json:"group,omitempty"`
	Runnable       bool     `json:"runnable"`
	HasSubcommands bool     `json:"has_subcommands"`
	// contains filtered or unexported fields
}

Source Files ¶

View all Source files

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