prompt

package

v1.39.0 Latest Latest Go to latest Published: Oct 28, 2026 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/auth0/auth0-cli

Links

Open Source Insights

Documentation ¶

Rendered for

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 AskMultiSelectWithDefault(message string, response interface{}, defaults []string, options ...string) error
func AskMultiSelectWithPageSize(message string, response interface{}, pageSize int, 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 ConfirmWithDefault(message string, defaultValue bool) bool
func EditorInput(name string, message string, help string, filename string, defaultValue string, ...) *survey.Question
func PaginatedSelectInput(name string, message string, help string, options []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

Constants ¶

This section is empty.

Variables ¶

View Source

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

View Source

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

Functions ¶

func Ask ¶

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

func AskBool ¶ added in v0.6.0

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

func AskMultiSelect ¶ added in v1.4.0

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

func AskMultiSelectWithDefault ¶ added in v1.35.0

func AskMultiSelectWithDefault(message string, response interface{}, defaults []string, options ...string) error

AskMultiSelectWithDefault is AskMultiSelect with the given default options pre-selected.

func AskMultiSelectWithPageSize ¶ added in v1.39.0

func AskMultiSelectWithPageSize(message string, response interface{}, pageSize int, options ...string) error

AskMultiSelectWithPageSize is AskMultiSelect that shows pageSize options at a time, scrolling through longer lists instead of rendering them all at once.

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 ¶ added in v0.3.0

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

Confirm prompts the user with a yes/no question and returns their response. On EOF (e.g. piped input or --no-input mode) it returns false.

func ConfirmWithDefault ¶ added in v1.31.0

func ConfirmWithDefault(message string, defaultValue bool) bool

ConfirmWithDefault prompts with the given default value (Y/n when true, y/N when false). On EOF (e.g. --no-input mode) the default value is returned instead of false.

func EditorInput ¶ added in v0.10.2

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

func PaginatedSelectInput ¶ added in v1.24.0

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

func PasswordInput ¶ added in v0.10.2

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 ¶ added in v0.4.0

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

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

func (*Editor) Prompt ¶ added in v0.4.0

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

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

type EditorTemplateData ¶ added in v0.4.0

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL