ui

package

v0.2.0 Latest Latest Go to latest Published: Jun 11, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

Details

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

Repository

github.com/DvGils/notenv

Links

Open Source Insights

Documentation ¶

Overview ¶

Package ui is notenv's hand-rolled terminal UI: ANSI styling, prompts, an arrow-key select, and a spinner. Built on x/term raw mode, which is already a dependency, so it adds zero new supply-chain surface.

Styling honors NO_COLOR and TERM=dumb and disables itself off-TTY. All human-facing output goes to stderr; stdout stays reserved for data.

Index ¶

Variables
func Bold(s string) string
func Confirm(label string, def bool) (bool, error)
func Cyan(s string) string
func Dim(s string) string
func Failf(format string, a ...any)
func Green(s string) string
func Infof(format string, a ...any)
func Input(label, def string) (string, error)
func Interactive() bool
func Notef(format string, a ...any)
func Red(s string) string
func Select(label string, options []Option) (int, error)
func Spin(label string, fn func() error) error
func Successf(format string, a ...any)
func Warnf(format string, a ...any)
func Yellow(s string) string
type Option

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrCanceled = errors.New("canceled")

ErrCanceled is returned when the user aborts a prompt (Esc, q, Ctrl-C).

Functions ¶

func Bold ¶

func Bold(s string) string

func Confirm ¶

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

Confirm asks a yes/no question.

func Cyan ¶

func Cyan(s string) string

func Dim ¶

func Dim(s string) string

func Failf ¶

func Failf(format string, a ...any)

func Green ¶

func Green(s string) string

func Infof ¶

func Infof(format string, a ...any)

func Input ¶

func Input(label, def string) (string, error)

Input reads one echoed line; empty input returns def.

func Interactive ¶

func Interactive() bool

Interactive reports whether prompts are possible at all.

func Notef ¶

func Notef(format string, a ...any)

func Red ¶

func Red(s string) string

func Select ¶

func Select(label string, options []Option) (int, error)

Select renders an arrow-key picker on the controlling terminal and returns the chosen index. Keys: up/down (or k/j), Enter to choose, Esc/q/Ctrl-C to cancel (returns ErrCanceled). Without a usable raw-mode terminal it falls back to a numbered prompt.

func Spin ¶

func Spin(label string, fn func() error) error

Spin runs fn while animating a spinner on stderr, then reports the outcome as a success or failure status line. Off-TTY it degrades to plain lines.

func Successf ¶

func Successf(format string, a ...any)

func Warnf ¶

func Warnf(format string, a ...any)

func Yellow ¶

func Yellow(s string) string

Types ¶

type Option ¶

type Option struct {
	Label  string
	Detail string
}

Option is one selectable entry; Detail renders dimmed after the label.

Source Files ¶

View all Source files

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