prompt

Documentation

Overview

Package prompt provides functionality for filling struct from user input which the user is asked for on the command line.

Index

• Constants
• type Prompter
  • func New() *Prompter
  • func NewWithValidators(validators map[string]ValidatorFunc) *Prompter
  • func (p *Prompter) Run(v interface{}) error
• type ValidatorFunc

Constants

const (
	TagValueSkip     = "-"
	TagValueRequired = "required"
	TagValueValidate = "validate"
	TagValueName     = "name"
	TagValueMask     = "mask"
)

Available struct tag values for "prompt".

Types

type Prompter

type Prompter struct {
	// contains filtered or unexported fields
}

A Prompter prompts the user for input.

func New

func New() *Prompter

New creates a new Prompter.

func NewWithValidators

func NewWithValidators(validators map[string]ValidatorFunc) *Prompter

NewWithValidators creates a new Prompter with the given validator functions.

func (*Prompter) Run

func (p *Prompter) Run(v interface{}) error

Run executes the Prompter for the given struct.

type ValidatorFunc

type ValidatorFunc = promptui.ValidateFunc

ValidatorFunc validates prompt input.