ui

package

v1.9.0 Latest Latest Go to latest Published: Aug 9, 2026 License: MIT Imports: 12 Imported by: 0

Details

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

Repository

github.com/libops/sitectl

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func CanPromptInteractively() bool
func PromptChoice(opts ChoicePromptOptions) (string, bool, error)
func PromptTerminalWidth() (int, bool)
func PromptText(opts TextPromptOptions) (string, bool, error)
type Choice
type ChoicePromptOptions
type TextPromptOptions

Constants ¶

View Source

const (
	// PromptOutputEnvironment selects the terminal stream used by interactive prompts.
	PromptOutputEnvironment = "SITECTL_PROMPT_OUTPUT"
	// PromptOutputStderr keeps stdout available for machine-readable protocols such as plugin RPC.
	PromptOutputStderr = "stderr"
)

Variables ¶

This section is empty.

Functions ¶

func CanPromptInteractively ¶ added in v1.7.0

func CanPromptInteractively() bool

func PromptChoice ¶

func PromptChoice(opts ChoicePromptOptions) (string, bool, error)

func PromptTerminalWidth ¶ added in v1.7.0

func PromptTerminalWidth() (int, bool)

func PromptText ¶

func PromptText(opts TextPromptOptions) (string, bool, error)

Types ¶

type Choice ¶

type Choice struct {
	Value            string
	Label            string
	Help             string
	AllowCustomInput bool
}

type ChoicePromptOptions ¶

type ChoicePromptOptions struct {
	Name         string
	Sections     []string
	Choices      []Choice
	DefaultValue string
}

type TextPromptOptions ¶

type TextPromptOptions struct {
	Sections []string
	Prompt   string
}

Source Files ¶

View all Source files

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