gocliselect

Golang CLI Select

Lightweight interactive CLI selection library

Import the package

import "github.com/mfutselaar/gocliselect"

Usage

Create a new menu, supplying the question as a parameter

menu := gocliselect.NewMenu("Chose a colour")

Add any number of options by calling AddItem() supplying the display text of the option as well as the id

menu.AddItem("Red", "red")
menu.AddItem("Blue", "blue")
menu.AddItem("Green", "green")
menu.AddItem("Yellow", "yellow")
menu.AddItem("Cyan", "cyan")

If you wish to add a keybinding to an item, you can use AddItemWithInput() with the same parameters as AddItem(), but with an added rune.

menu.AddItemWithInput("Red", "red", 'r')
menu.AddItemWithInput("Blue", "blue", 'b')
menu.AddItemWithInput("Green", "green", 'g')
menu.AddItemWithInput("Yellow", "yellow", 'y')
menu.AddItemWithInput("Cyan", "cyan", 'c')

You can also add a divider by calling `AddDivider()

To display the menu and away the user choice call Display()

choice := menu.Display()

Example

package main

import (
    "fmt"
    "github.com/nexidian/gocliselect"
)

func main() {
    menu := gocliselect.NewMenu("Chose a colour")

    menu.AddItem("Red", "red")
    menu.AddItem("Blue", "blue")
    menu.AddItem("Green", "green")
    menu.AddItem("Yellow", "yellow")
    menu.AddItem("Cyan", "cyan")
    menu.AddDivider()
    menu.AddItem("Quit", "quit", 'q')

    choice, err := menu.Display()
    if err != nil {
        fmt.Printf("Error: %v\n", err)
    }

    if choice == "quit" {
        fmt.Println("You choose to quit")
    } else {
        fmt.Printf("Choice: %s\n", choice)
    }
}