A super tiny Go module which allows to prompt users for command line input while the terminal is in raw mode. This provides some more flexibility where you can provide default values on the command line which can be overwritten depending on the InputMode you're in.
This module can help with the following use cases when you're asking for input on the command line:
- You want to provide a default value which can easily be modified by the user.
- You're asking for input in a special format which is cumbersome to type. You can provide a default value in the right format and the user only overwrites individual characters.
Here's a fully working example. Error handling's omitted for brevity.
package main
import (
"fmt"
"os"
"github.com/baumgarb/rawterm"
)
func main() {
term := rawterm.New(os.Stdin, os.Stdout)
// Terminal is in 'FixedLength' input mode by default. That's useful if you're asking for input with a specific length and in a specific format
// so that users only need to overwrite a few characters instead of typing the long and cumbersome format themselves.
//
// Users can only use left and right arrow keys and overwrite the character at the cursor. Nothing else.
startTS, _ := term.ReadString("Enter start timestamp", "2023-01-01T00:00:00.000Z")
endTS, _ := term.ReadString("Enter end timestamp", "2023-12-31T23:59:59.999Z")
// Change to 'Flexible' mode so users can delete characters and enter an answer of variable length
term.Mode = rawterm.Flexible
name, _ := term.ReadString("Enter your full name", "Jane Doe")
fmt.Printf("You entered the following information: \n\tStart: %v\n\tEnd: %v\n\tFull name: %v\n", startTS, endTS, name)
}