ui

Documentation

Index

• Variables
• func RenderCommandHelp(cmd *cobra.Command) string
• func RenderInfo(message string) string
• func RenderSuccess(message string) string
• func RenderWarning(message string) string
• func RunConfirm(prompt string, initialValue bool) (bool, error)
• func RunTextInput(prompt string, placeholder string, initialValue string, validate Validator) (string, error)
• type Option
  • func RunSelect(prompt string, options []Option, initialIndex int) (Option, error)
• type Validator

Variables

var ErrCancelled = errors.New("prompt cancelled")

ErrCancelled is returned when the user exits an interactive prompt.

Functions

func RenderCommandHelp

func RenderCommandHelp(cmd *cobra.Command) string

RenderCommandHelp renders a styled help view for Cobra commands.

func RenderInfo

func RenderInfo(message string) string

RenderInfo renders an informational message.

func RenderSuccess

func RenderSuccess(message string) string

RenderSuccess renders a success message.

func RenderWarning

func RenderWarning(message string) string

RenderWarning renders a warning message.

func RunConfirm

func RunConfirm(prompt string, initialValue bool) (bool, error)

RunConfirm renders a simple yes/no prompt.

func RunTextInput

func RunTextInput(prompt string, placeholder string, initialValue string, validate Validator) (string, error)

RunTextInput renders a simple single-line text prompt.

Types

type Option

type Option struct {
	Label       string
	Description string
	Value       string
}

Option is a single selectable item in the TUI.

func RunSelect

func RunSelect(prompt string, options []Option, initialIndex int) (Option, error)

RunSelect renders a simple keyboard-driven selector.

type Validator

type Validator func(value string) error

Validator validates text input.