helpui

package
v1.0.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 24, 2026 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Entry

type Entry struct {
	ID       string   `json:"id"`
	Kind     string   `json:"kind"` // command|flag|env
	Title    string   `json:"title"`
	Subtitle string   `json:"subtitle,omitempty"`
	Sources  []string `json:"sources,omitempty"`
	Links    []Link   `json:"links,omitempty"`
	Content  string   `json:"content,omitempty"`
	Examples []string `json:"examples,omitempty"`
	Tags     []string `json:"tags,omitempty"`
}

type Index

type Index struct {
	GeneratedAt string  `json:"generatedAt"`
	Entries     []Entry `json:"entries"`
}

func BuildIndex

func BuildIndex(root *cobra.Command, includeHidden bool) Index
type Link struct {
	ID    string `json:"id"`
	Title string `json:"title"`
}

type Option

type Option func(*Server)

func WithAll

func WithAll() Option

type Server

type Server struct {
	// contains filtered or unexported fields
}

func New

func New(addr string, root *cobra.Command, logger logr.Logger, opts ...Option) *Server

func (*Server) Run

func (s *Server) Run(ctx context.Context) error

Jump to

Keyboard shortcuts

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