prompt

Documentation

Index

• Variables
• func Ask(inputs []*survey.Question, response interface{}) error
• func AskBool(message string, value *bool, defaultValue bool) error
• func AskMultiSelect(message string, response interface{}, options ...string) error
• func AskOne(input *survey.Question, response interface{}) error
• func BoolInput(name string, message string, help string, defaultValue bool, required bool) *survey.Question
• func CaptureInputViaEditor(contents, pattern string, infoFn func(), fileCreatedFn func(string)) (result string, err error)
• func Confirm(message string) bool
• func EditorInput(name string, message string, help string, filename string, defaultValue string, ...) *survey.Question
• func PasswordInput(name string, message string, required bool) *survey.Question
• func SelectInput(name string, message string, help string, options []string, ...) *survey.Question
• func TextInput(name string, message string, help string, defaultValue string, required bool) *survey.Question
• type Editor
  • func (e *Editor) Prompt(config *survey.PromptConfig) (interface{}, error)
• type EditorTemplateData

Variables

var EditorQuestionTemplate = `` /* 714-byte string literal not displayed */

var Icons = survey.WithIcons(func(icons *survey.IconSet) {
	icons.Question.Text = ""
})

Functions

func Ask

func Ask(inputs []*survey.Question, response interface{}) error

func AskBool

func AskBool(message string, value *bool, defaultValue bool) error

func AskMultiSelect

func AskMultiSelect(message string, response interface{}, options ...string) error

func AskOne

func AskOne(input *survey.Question, response interface{}) error

func BoolInput

func BoolInput(name string, message string, help string, defaultValue bool, required bool) *survey.Question

func CaptureInputViaEditor

func CaptureInputViaEditor(contents, pattern string, infoFn func(), fileCreatedFn func(string)) (result string, err error)

CaptureInputViaEditor is the high level function to use in this package in order to capture input from an editor.

The arguments have been tailored for our use of strings mostly in the rest of the CLI even though internally we're using []byte.

func Confirm

func Confirm(message string) bool

func EditorInput

func EditorInput(name string, message string, help string, filename string, defaultValue string, required bool) *survey.Question

func PasswordInput

func PasswordInput(name string, message string, required bool) *survey.Question

func SelectInput

func SelectInput(name string, message string, help string, options []string, defaultValue string, required bool) *survey.Question

func TextInput

func TextInput(name string, message string, help string, defaultValue string, required bool) *survey.Question

Types

type Editor

type Editor struct {
	*survey.Editor
	EditorCommand string
	BlankAllowed  bool
}

Editor is an extended survey.Editor to enable different prompting behavior.

func (*Editor) Prompt

func (e *Editor) Prompt(config *survey.PromptConfig) (interface{}, error)

Prompt is a straight copy from survey to get our overridden prompt called.

type EditorTemplateData

type EditorTemplateData struct {
	survey.Editor
	EditorCommand string
	BlankAllowed  bool
	Answer        string
	ShowAnswer    bool
	ShowHelp      bool
	Config        *survey.PromptConfig
}