prompt

Documentation

Overview

Package prompt provides consistent confirmation gates for destructive commands: interactive y/N (or type-to-confirm) on a terminal, and a required --force flag when running non-interactively so scripts fail safe.

Index

• Variables
• func Ask(cmd *cobra.Command, question, def string) string
• func AskSecret(cmd *cobra.Command, question string) string
• func Confirm(cmd *cobra.Command, question string, force bool) error
• func ConfirmName(cmd *cobra.Command, action, expected string, force bool) error

Variables

var ErrAborted = errors.New("aborted")

ErrAborted is returned when the user declines a confirmation.

Functions

func Ask

func Ask(cmd *cobra.Command, question, def string) string

Ask prompts on a TTY for a line of text, showing def as the default. It returns def when the user presses enter on an empty line, or immediately (no prompt) when stdin is not a terminal — so non-interactive runs use defaults.

func AskSecret

func AskSecret(cmd *cobra.Command, question string) string

AskSecret prompts on a TTY for a secret without echoing it (via term.ReadPassword), so tokens never appear on screen or in scrollback. It returns "" when stdin is not a terminal — non-interactive runs should supply secrets via flags or stdin, not this prompt.

func Confirm

func Confirm(cmd *cobra.Command, question string, force bool) error

Confirm gates a destructive action with a y/N question. force (from --force) approves it unconditionally. Otherwise it prompts on a TTY (defaulting to no); with no TTY and no --force it refuses so piped/CI runs fail safe.

func ConfirmName

func ConfirmName(cmd *cobra.Command, action, expected string, force bool) error

ConfirmName gates a severe action (e.g. deleting a store and all its data) behind typing the resource's exact name. force skips it; a non-TTY without --force refuses.