confirm

Documentation

Index

• type Options
  • func (o Options) Run() error

Types

type Options

type Options struct {
	Default     bool         `help:"Default confirmation action" default:"true"`
	Affirmative string       `help:"The title of the affirmative action" default:"Yes"`
	Negative    string       `help:"The title of the negative action" default:"No"`
	Prompt      string       `arg:"" help:"Prompt to display." default:"Are you sure?"`
	PromptStyle style.Styles `embed:"" prefix:"prompt." help:"The style of the prompt" set:"defaultMargin=1 0 0 1" envprefix:"GUM_CONFIRM_PROMPT_"`
	//nolint:staticcheck
	SelectedStyle style.Styles `` /* 206-byte string literal not displayed */
	//nolint:staticcheck
	UnselectedStyle style.Styles  `` /* 212-byte string literal not displayed */
	Timeout         time.Duration `help:"Timeout until confirm returns selected value or default if provided" default:"0" env:"GUM_CONFIRM_TIMEOUT"`
}

Options is the customization options for the confirm command.

func (Options) Run

func (o Options) Run() error

Run provides a shell script interface for prompting a user to confirm an action with an affirmative or negative answer.