Add liner and enable interactive cli to have a history and the user to iterate through history (#69)

Author: Luke-Ed

cli/entry.go

@@ -17,9 +17,10 @@
 package cli
 
 import (
-	"bufio"
+	"errors"
 	"fmt"
 	"github.com/james4k/rcon"
+	"github.com/peterh/liner"
 	"io"
 	"log"
 	"os"
@@ -55,17 +56,35 @@ var colors = map[string]string{
 	"r": Reset,        // reset
 }
 
-func Start(hostPort string, password string, in io.Reader, out io.Writer) {
+func Start(hostPort string, password string, out io.Writer) {
 	remoteConsole, err := rcon.Dial(hostPort, password)
 	if err != nil {
 		log.Fatal("Failed to connect to RCON server", err)
 	}
 	defer remoteConsole.Close()
 
-	scanner := bufio.NewScanner(in)
-	_, _ = out.Write([]byte("> "))
-	for scanner.Scan() {
-		cmd := scanner.Text()
+	lineEditor := liner.NewLiner()
+	defer lineEditor.Close()
+
+	for {
+		cmd, err := lineEditor.Prompt("> ")
+
+		if err != nil {
+			if errors.Is(err, liner.ErrPromptAborted) {
+				return
+			}
+
+			if errors.Is(err, io.EOF) {
+				return
+			}
+
+			_, _ = fmt.Fprintln(os.Stderr, "Error reading input:", err)
+		}
+
+		if cmd == "exit" {
+			return
+		}
+
 		reqId, err := remoteConsole.Write(cmd)
 		if err != nil {
 			_, _ = fmt.Fprintln(os.Stderr, "Failed to send command:", err.Error())
@@ -87,11 +106,8 @@ func Start(hostPort string, password string, in io.Reader, out io.Writer) {
 
 		resp = colorize(resp)
 		_, _ = fmt.Fprintln(out, resp)
-		_, _ = out.Write([]byte("> "))
-	}
 
-	if err := scanner.Err(); err != nil {
-		_, _ = fmt.Fprintln(os.Stderr, "reading standard input:", err)
+		lineEditor.AppendHistory(cmd)
 	}
 }
 

cmd/root.go

@@ -54,7 +54,7 @@ and the CLI will exit.
 		password := viper.GetString("password")
 
 		if len(args) == 0 {
-			cli.Start(hostPort, password, os.Stdin, os.Stdout)
+			cli.Start(hostPort, password, os.Stdout)
 		} else {
 			cli.Execute(hostPort, password, os.Stdout, args...)
 		}

go.mod

@@ -11,8 +11,10 @@ require (
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/mattn/go-runewidth v0.0.3 // indirect
 	github.com/mitchellh/mapstructure v1.5.0 // indirect
 	github.com/pelletier/go-toml/v2 v2.2.2 // indirect
+	github.com/peterh/liner v1.2.2 // indirect
 	github.com/sagikazarmark/locafero v0.4.0 // indirect
 	github.com/sagikazarmark/slog-shim v0.1.0 // indirect
 	github.com/sourcegraph/conc v0.3.0 // indirect

go.sum

@@ -21,10 +21,14 @@ github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/magiconair/properties v1.8.7 h1:IeQXZAiQcpL9mgcAe1Nu6cX9LLw6ExEHKjN0VQdvPDY=
 github.com/magiconair/properties v1.8.7/go.mod h1:Dhd985XPs7jluiymwWYZ0G4Z61jb3vdS329zhj2hYo0=
+github.com/mattn/go-runewidth v0.0.3 h1:a+kO+98RDGEfo6asOGMmpodZq4FNtnGP54yps8BzLR4=
+github.com/mattn/go-runewidth v0.0.3/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU=
 github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY=
 github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
 github.com/pelletier/go-toml/v2 v2.2.2 h1:aYUidT7k73Pcl9nb2gScu7NSrKCSHIDE89b3+6Wq+LM=
 github.com/pelletier/go-toml/v2 v2.2.2/go.mod h1:1t835xjRzz80PqgE6HHgN2JOsmgYu/h4qDAS4n929Rs=
+github.com/peterh/liner v1.2.2 h1:aJ4AOodmL+JxOZZEL2u9iJf8omNRpqHc/EbrK+3mAXw=
+github.com/peterh/liner v1.2.2/go.mod h1:xFwJyiKIXJZUKItq5dGHZSTBRAuG/CpeNpWLyiNRNwI=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U=
 github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
@@ -65,6 +69,7 @@ go.uber.org/multierr v1.9.0 h1:7fIwc/ZtS0q++VgcfqFDxSBZVv/Xo49/SYnDFupUwlI=
 go.uber.org/multierr v1.9.0/go.mod h1:X2jQV1h+kxSjClGpnseKVIxpmcjrj7MNnI0bnlfKTVQ=
 golang.org/x/exp v0.0.0-20230905200255-921286631fa9 h1:GoHiUyI/Tp2nVkLI2mCxVkOjsbSXD66ic0XW0js0R9g=
 golang.org/x/exp v0.0.0-20230905200255-921286631fa9/go.mod h1:S2oDrQGGwySpoQPVqRShND87VCbxmc6bL1Yd2oYrm6k=
+golang.org/x/sys v0.0.0-20211117180635-dee7805ff2e1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
 golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=