manifoldco/promptui

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 146 Commits
.github		.github
_examples		_examples
list		list
screenbuf		screenbuf
.gitignore		.gitignore
.golangci.yml		.golangci.yml
.travis.yml		.travis.yml
CHANGELOG.md		CHANGELOG.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
LICENSE.md		LICENSE.md
Makefile		Makefile
README.md		README.md
codes.go		codes.go
codes_test.go		codes_test.go
cursor.go		cursor.go
cursor_test.go		cursor_test.go
example_main_test.go		example_main_test.go
example_prompt_test.go		example_prompt_test.go
example_select_test.go		example_select_test.go
example_selectwithadd_test.go		example_selectwithadd_test.go
go.mod		go.mod
go.sum		go.sum
keycodes.go		keycodes.go
keycodes_other.go		keycodes_other.go
keycodes_windows.go		keycodes_windows.go
prompt.go		prompt.go
promptui.go		promptui.go
select.go		select.go
select_test.go		select_test.go
styles.go		styles.go
styles_windows.go		styles_windows.go

Repository files navigation

promptui

Interactive prompt for command-line applications.

We built Promptui because we wanted to make it easy and fun to explore cloud services with manifold cli.

Code of Conduct | Contribution Guidelines

GitHub release GoDoc Travis Go Report Card License

Overview

promptui

Promptui is a library providing a simple interface to create command-line prompts for go. It can be easily integrated into spf13/cobra, urfave/cli or any cli go application.

Promptui has two main input modes:

Prompt provides a single line for user input. Prompt supports optional live validation, confirmation and masking the input.
Select provides a list of options to choose from. Select supports pagination, search, detailed view and custom templates.

For a full list of options check GoDoc.

Basic Usage

Prompt

package main
import (
	"errors"
	"fmt"
	"strconv"
	"github.com/manifoldco/promptui"
)
func main() {
	validate := func(input string) error {
		_, err := strconv.ParseFloat(input, 64)
		if err != nil {
			return errors.New("Invalid number")
		}
		return nil
	}
	prompt := promptui.Prompt{
		Label: "Number",
		Validate: validate,
	}
	result, err := prompt.Run()
	if err != nil {
		fmt.Printf("Prompt failed %v\n", err)
		return
	}
	fmt.Printf("You choose %q\n", result)
}

Select

package main
import (
	"fmt"
	"github.com/manifoldco/promptui"
)
func main() {
	prompt := promptui.Select{
		Label: "Select Day",
		Items: []string{"Monday", "Tuesday", "Wednesday", "Thursday", "Friday",
			"Saturday", "Sunday"},
	}
	_, result, err := prompt.Run()
	if err != nil {
		fmt.Printf("Prompt failed %v\n", err)
		return
	}
	fmt.Printf("You choose %q\n", result)
}