terminal

Documentation

Index

• Constants
• func CollectInput(prompt *Prompt) (string, error)
• func CollectSelect(prompt Prompt) (int, error)
• type Prompt

Constants

const TerminalInterruptCode = 130

TerminalInterruptCode is the exit status for interrupted prompts

Functions

func CollectInput

func CollectInput(prompt *Prompt) (string, error)

CollectInput gathers a value for the prompt from flag, environment, or input

func CollectSelect

func CollectSelect(prompt Prompt) (int, error)

CollectSelect gathers the index of the selected value for a prompt

Types

type Prompt

type Prompt struct {
	Message     string     // Promptful message for the input
	Flag        *flag.Flag // Substituting flag, preferred if set
	Environment string     // Related environment variable name

	Options      []string // Available selection options
	Descriptions []string // Optional option descriptions
	Hidden       bool     // Mask any text inputs
}

Prompt holds the information needed for gathering inputs