Commited dependencies
This commit is contained in:
106
vendor/github.com/manifoldco/promptui/README.md
generated
vendored
Normal file
106
vendor/github.com/manifoldco/promptui/README.md
generated
vendored
Normal file
@@ -0,0 +1,106 @@
|
||||
# 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](https://github.com/manifoldco/manifold-cli).
|
||||
|
||||
[Code of Conduct](./CODE_OF_CONDUCT.md) |
|
||||
[Contribution Guidelines](./.github/CONTRIBUTING.md)
|
||||
|
||||
[](https://github.com/manifoldco/promptui/releases)
|
||||
[](https://godoc.org/github.com/manifoldco/promptui)
|
||||
[](https://travis-ci.org/manifoldco/promptui)
|
||||
[](https://goreportcard.com/report/github.com/manifoldco/promptui)
|
||||
[](./LICENSE.md)
|
||||
|
||||
## Overview
|
||||
|
||||

|
||||
|
||||
Promptui is a library providing a simple interface to create command-line
|
||||
prompts for go. It can be easily integrated into
|
||||
[spf13/cobra](https://github.com/spf13/cobra),
|
||||
[urfave/cli](https://github.com/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](https://godoc.org/github.com/manifoldco/promptui).
|
||||
|
||||
## Basic Usage
|
||||
|
||||
### Prompt
|
||||
|
||||
```go
|
||||
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
|
||||
|
||||
```go
|
||||
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)
|
||||
}
|
||||
```
|
||||
|
||||
### More Examples
|
||||
|
||||
See full list of [examples](https://github.com/manifoldco/promptui/tree/master/_examples)
|
||||
Reference in New Issue
Block a user