prompt

package

v0.67.0 Latest Latest Go to latest Published: May 30, 2026 License: MIT Imports: 9 Imported by: 0

Details

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

Repository

github.com/GoCodeAlone/workflow

Links

Open Source Insights

Documentation ¶

Overview ¶

Package prompt provides reusable terminal UI widgets built on charm.land/bubbletea/v2 and charm.land/bubbles/v2.

Every public constructor checks whether stdin is an interactive terminal before starting a bubbletea program. If stdin is not a terminal the constructor returns (zero, ErrNotInteractive) immediately so callers in CI / pipe mode can detect the condition and fall back to non-interactive paths without any risk of hanging.

Index ¶

Variables
func Confirm(question string, def bool) (bool, error)
func Input(label string, masked bool) (string, error)
func MultiSelect(title string, items []Item) ([]int, error)
func Select(title string, opts []string) (int, error)
type Item

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrNotInteractive = errors.New("prompt: stdin is not a terminal")

ErrNotInteractive is returned by all constructors when stdin is not a terminal.

Functions ¶

func Confirm ¶

func Confirm(question string, def bool) (bool, error)

Confirm asks a yes/no question. def is the default answer shown in the prompt (used when the user presses Enter without typing y/n).

Returns (false, ErrNotInteractive) when stdin is not a terminal.

func Input ¶

func Input(label string, masked bool) (string, error)

Input prompts the user for a single-line text value. When masked is true the input is displayed as asterisks (suitable for passwords/tokens).

Returns ("", ErrNotInteractive) when stdin is not a terminal.

func MultiSelect ¶

func MultiSelect(title string, items []Item) ([]int, error)

MultiSelect presents an interactive multi-choice list. Returns the indices of all selected items. Items can be pre-selected via Item.Preselected.

Returns (nil, ErrNotInteractive) when stdin is not a terminal.

func Select ¶

func Select(title string, opts []string) (int, error)

Select presents an interactive single-choice list to the user and returns the index of the chosen item.

Returns (0, ErrNotInteractive) when stdin is not a terminal.

Types ¶

type Item ¶

type Item struct {
	Label       string
	Preselected bool
}

Item is a selectable entry for MultiSelect.

Source Files ¶

View all Source files

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