add non-interactive mode: -c, script files and commands from stdin

- gosh -c 'command' runs the command and exits, so gosh works as login
  shell for ssh host command, scp and rsync
- gosh script runs a script file, lines starting with # are skipped
- without a terminal, commands are read from stdin (byte by byte, so
  started commands can read the rest of stdin)
- the exit status is the one of the last command (127 not found,
  126 not executable, 128+n killed by signal n)
- -i forces interactive mode, -l/--login is accepted

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

.goreleaser.yaml

@@ -22,7 +22,7 @@ builds:
     flags:
       - -trimpath
     ldflags:
-      - -s -w -X main.version={{ .Version }}
+      - -s -w -X main.version={{ .Version }} -X main.commit={{ .ShortCommit }} -X main.branch={{ .Branch }}
     goos:
       - linux
       - darwin

README.md

@@ -2,6 +2,7 @@
 
 ```
 gosh - Go Shell
+Version: 0.2.1 (branch: main, commit: 03e791c)
 
 Built-in commands:
   cd [dir]       - Change directory (cd with no args goes to home)
@@ -28,9 +29,32 @@ Features:
     disabled with $NO_COLOR, TERM=dumb or when output is not a terminal
   - Environment variable expansion ($VAR, ${VAR}, ${VAR:-default});
     using an unset variable is an error, use ${VAR:-} for an empty default
+  - Non-interactive use: gosh -c 'command', gosh script, command | gosh;
+    the exit status is the one of the last command
 
 ```
 
+### Aufruf
+
+```
+gosh [-l] [-i] [script]
+gosh [-l] -c command
+gosh -version
+```
+
+| Aufruf                 | Verhalten                                                        |
+|------------------------|------------------------------------------------------------------|
+| `gosh`                 | interaktive Shell (wenn stdin ein Terminal ist)                  |
+| `gosh -c 'befehl'`     | führt den Befehl aus und beendet sich                            |
+| `gosh skript.gosh`     | führt das Skript Zeile für Zeile aus                             |
+| `befehle \| gosh`      | liest die Befehle von stdin                                      |
+| `-i`                   | erzwingt den interaktiven Modus, auch ohne Terminal              |
+| `-l`, `--login`        | Login-Shell (wird akzeptiert, eine Startdatei gibt es noch nicht) |
+
+Ohne Terminal bricht gosh bei einem fehlgeschlagenen Befehl nicht ab und beendet sich mit dem Exit-Status des letzten Befehls: `127`, wenn ein Befehl nicht gefunden wurde, `126`, wenn er nicht ausführbar ist, `128+n`, wenn er durch Signal `n` beendet wurde. Leere Zeilen und Zeilen, die mit `#` beginnen, werden übersprungen, Skripte können also mit `#!/usr/bin/gosh` beginnen.
+
+Damit funktionieren auch `ssh host befehl`, `scp` und `rsync`, wenn gosh als Login-Shell gesetzt ist. Da gosh `;`, `&&` und Pipes noch nicht kennt, darf der Befehl dabei aber nur aus einem einfachen Kommando bestehen.
+
 ### Farben
 
 Der Prompt wird über die Umgebungsvariable `GOSH_COLORS` eingefärbt. Sie besteht aus durch `:` getrennten Einträgen `schlüssel=code`:
@@ -102,6 +126,15 @@ _gosh is not meant for production use, it is just a proof of concept._
 go build ./
 ```
 
+Die Version lässt sich mit `gosh -version` (oder `--version`, `-V`) abfragen und steht auch in der Ausgabe von `help`:
+
+```
+$ gosh -version
+gosh 0.2.1 (branch: main, commit: 03e791c)
+```
+
+Version und Branch werden beim Bauen mit GoReleaser per `-ldflags` gesetzt. Bei einem einfachen `go build` steht dort `dev`, der Commit wird dann aus den von Go eingebetteten Git-Informationen gelesen (mit `-dirty`, falls es uncommittete Änderungen gab).
+
 ## Release
 
 Binaries sowie `.deb`- und `.rpm`-Pakete werden mit [GoReleaser](https://goreleaser.com) gebaut (Konfiguration: `.goreleaser.yaml`).

main.go

@@ -1,15 +1,19 @@
 package main
 
 import (
+	"bufio"
 	"errors"
 	"fmt"
 	"io"
+	"io/fs"
 	"os"
 	"os/exec"
 	"os/signal"
 	"os/user"
 	"path/filepath"
+	"runtime/debug"
 	"strings"
+	"syscall"
 	"unicode"
 	"unicode/utf8"
 
@@ -19,8 +23,51 @@ import (
 // ErrNoPath is returned when 'cd' was called without a second argument.
 var ErrNoPath = errors.New("path required")
 
-// version is set at build time via -ldflags "-X main.version=..."
+// Build information, set at build time via
-var version = "dev"
+// -ldflags "-X main.version=... -X main.commit=... -X main.branch=...".
+var (
+	version = "dev"
+	commit  = ""
+	branch  = ""
+)
+
+// versionInfo returns the version including branch and commit, e.g.
+// "0.2.1 (branch: main, commit: 03e791c)". Without ldflags (plain go build)
+// the commit is taken from the VCS information that Go embeds in the binary.
+func versionInfo() string {
+	c := commit
+	if c == "" {
+		if info, ok := debug.ReadBuildInfo(); ok {
+			var dirty bool
+			for _, s := range info.Settings {
+				switch s.Key {
+				case "vcs.revision":
+					c = s.Value
+				case "vcs.modified":
+					dirty = s.Value == "true"
+				}
+			}
+			if len(c) > 7 {
+				c = c[:7]
+			}
+			if c != "" && dirty {
+				c += "-dirty"
+			}
+		}
+	}
+
+	var details []string
+	if branch != "" {
+		details = append(details, "branch: "+branch)
+	}
+	if c != "" {
+		details = append(details, "commit: "+c)
+	}
+	if len(details) == 0 {
+		return version
+	}
+	return version + " (" + strings.Join(details, ", ") + ")"
+}
 
 // previousDir tracks the previous working directory for 'cd -' support
 var previousDir string
@@ -567,12 +614,151 @@ func completeFilePath(line, prefix string) []string {
 	return matches
 }
 
+const usage = `usage: gosh [-l] [-i] [script]
+       gosh [-l] -c command
+       gosh -version`
+
 func main() {
-	if len(os.Args) > 1 && (os.Args[1] == "--version" || os.Args[1] == "-V") {
+	os.Exit(run(os.Args[1:]))
-		fmt.Println("gosh", version)
-		return
 }
 
+// run parses the command line and runs gosh in the matching mode. It returns
+// the exit status of the shell.
+func run(args []string) int {
+	// -l/--login is accepted for compatibility (e.g. "su -l", login(1)), but
+	// gosh does not read a startup file yet. -i forces interactive mode even
+	// if stdin is not a terminal.
+	forceInteractive := false
+flags:
+	for len(args) > 0 {
+		switch args[0] {
+		case "-l", "--login":
+		case "-i":
+			forceInteractive = true
+		default:
+			break flags
+		}
+		args = args[1:]
+	}
+
+	if len(args) > 0 {
+		switch arg := args[0]; {
+		case arg == "-version" || arg == "--version" || arg == "-V":
+			fmt.Println("gosh", versionInfo())
+			return 0
+		case arg == "-h" || arg == "--help":
+			fmt.Println(usage)
+			return 0
+		case arg == "-c":
+			// Like sh, further arguments are allowed (they would become $0,
+			// $1, ...), but gosh has no positional parameters yet.
+			if len(args) < 2 {
+				fmt.Fprintln(os.Stderr, "gosh: -c: option requires an argument")
+				fmt.Fprintln(os.Stderr, usage)
+				return 2
+			}
+			return runScript(strings.NewReader(args[1]))
+		case strings.HasPrefix(arg, "-") && arg != "-":
+			fmt.Fprintf(os.Stderr, "gosh: %s: invalid option\n", arg)
+			fmt.Fprintln(os.Stderr, usage)
+			return 2
+		case arg == "-":
+			return runScript(os.Stdin)
+		default:
+			f, err := os.Open(arg)
+			if err != nil {
+				fmt.Fprintln(os.Stderr, "gosh:", err)
+				return 127
+			}
+			defer f.Close()
+			return runScript(bufio.NewReader(f))
+		}
+	}
+
+	// Without a terminal (e.g. "echo ls | gosh") read the commands from stdin.
+	if !forceInteractive && !readline.IsTerminal(int(os.Stdin.Fd())) {
+		return runScript(os.Stdin)
+	}
+
+	interactive()
+	return 0
+}
+
+// runScript executes the commands from r line by line. Like sh, it does not
+// stop at a failing command and returns the exit status of the last one.
+// Empty lines and lines starting with # (e.g. a #!/usr/bin/gosh line) are
+// skipped.
+func runScript(r io.Reader) int {
+	status := 0
+	for {
+		line, err := readLine(r)
+		if trimmed := strings.TrimSpace(line); trimmed != "" && !strings.HasPrefix(trimmed, "#") {
+			cmdErr := execInput(line)
+			status = exitStatus(cmdErr)
+			// A command that ran and failed reports its own errors.
+			var exitErr *exec.ExitError
+			if cmdErr != nil && !errors.As(cmdErr, &exitErr) {
+				fmt.Fprintln(os.Stderr, "gosh:", cmdErr)
+			}
+		}
+		if err != nil {
+			if err != io.EOF {
+				fmt.Fprintln(os.Stderr, "gosh:", err)
+				return 1
+			}
+			return status
+		}
+	}
+}
+
+// readLine reads a single line from r without the trailing newline. It reads
+// byte by byte so that nothing after the line is consumed: when the script
+// comes from stdin, the commands it starts read the rest of stdin (like in
+// sh, "printf 'cat\nhello\n' | gosh" prints hello). Pass a bufio.Reader if
+// that does not matter.
+func readLine(r io.Reader) (string, error) {
+	var b strings.Builder
+	buf := make([]byte, 1)
+	for {
+		n, err := r.Read(buf)
+		if n > 0 {
+			if buf[0] == '\n' {
+				return b.String(), nil
+			}
+			b.WriteByte(buf[0])
+		}
+		if err != nil {
+			return b.String(), err
+		}
+	}
+}
+
+// exitStatus converts the result of execInput into a shell exit status: the
+// exit code of the command, 128+n if it was killed by signal n, 127 if it was
+// not found, 126 if it could not be executed and 1 for other errors.
+func exitStatus(err error) int {
+	if err == nil {
+		return 0
+	}
+	var exitErr *exec.ExitError
+	if errors.As(err, &exitErr) {
+		if ws, ok := exitErr.Sys().(syscall.WaitStatus); ok && ws.Signaled() {
+			return 128 + int(ws.Signal())
+		}
+		return exitErr.ExitCode()
+	}
+	if errors.Is(err, exec.ErrNotFound) || errors.Is(err, fs.ErrNotExist) {
+		return 127
+	}
+	if errors.Is(err, fs.ErrPermission) {
+		return 126
+	}
+	return 1
+}
+
+// interactive runs the interactive shell with line editing, history and
+// completion until the user exits.
+func interactive() {
 	// Ctrl+C sends SIGINT to the whole foreground process group. Catch it so
 	// that it only stops the running command and not the shell. (signal.Ignore
 	// would be inherited by the child processes.)
@@ -727,7 +913,7 @@ func execInput(input string) error {
 		os.Setenv(parts[0], parts[1])
 		return nil
 	case "help":
-		fmt.Println(`gosh - Go Shell
+		fmt.Println("gosh - Go Shell\nVersion: " + versionInfo() + `
 
 Built-in commands:
   cd [dir]       - Change directory (cd with no args goes to home)
@@ -753,16 +939,22 @@ Features:
     (keys user, root, path; values are ANSI SGR codes, empty = no color);
     disabled with $NO_COLOR, TERM=dumb or when output is not a terminal
   - Environment variable expansion ($VAR, ${VAR}, ${VAR:-default});
-    using an unset variable is an error, use ${VAR:-} for an empty default`)
+    using an unset variable is an error, use ${VAR:-} for an empty default
+  - Non-interactive use: gosh -c 'command', gosh script, command | gosh;
+    the exit status is the one of the last command`)
 		return nil
 	}
 
 	// Prepare the command to execute.
 	cmd := exec.Command(args[0], args[1:]...)
 
-	// Set the correct output device.
+	// Connect the command to the terminal. Without Stdin the command would
-	cmd.Stderr = os.Stderr
+	// read from /dev/null, so interactive programs (su, vim, ssh, ...) would
+	// get EOF right away. readline only reads from stdin while a line is
+	// being edited, so it does not steal input from the command.
+	cmd.Stdin = os.Stdin
 	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
 
 	// Execute the command return the error.
 	return cmd.Run()

main_test.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"errors"
 	"bytes"
 	"io"
 	"os"
@@ -648,6 +649,21 @@ func TestExecInput_ExportNoArgs(t *testing.T) {
 	}
 }
 
+func TestVersionInfo(t *testing.T) {
+	origVersion, origCommit, origBranch := version, commit, branch
+	defer func() { version, commit, branch = origVersion, origCommit, origBranch }()
+
+	version, commit, branch = "1.2.3", "abc1234", "main"
+	if got := versionInfo(); got != "1.2.3 (branch: main, commit: abc1234)" {
+		t.Errorf("versionInfo() = %q", got)
+	}
+
+	branch = ""
+	if got := versionInfo(); got != "1.2.3 (commit: abc1234)" {
+		t.Errorf("versionInfo() without branch = %q", got)
+	}
+}
+
 func TestExecInput_Help(t *testing.T) {
 	// Just verify help doesn't return an error
 	// We can't easily capture stdout in a unit test without a pipe
@@ -1158,7 +1174,7 @@ func TestShell_History(t *testing.T) {
 	histFile := filepath.Join(t.TempDir(), "gosh", "history")
 	workDir := t.TempDir()
 
-	cmd := exec.Command(bin)
+	cmd := exec.Command(bin, "-i")
 	cmd.Dir = workDir
 	cmd.Env = append(os.Environ(), "GOSH_HISTFILE="+histFile)
 	cmd.Stdin = strings.NewReader("echo first\n set SECRET=hunter2\nexit\n")
@@ -1190,7 +1206,7 @@ func TestShell_History(t *testing.T) {
 func TestShell_SIGINTKillsOnlyChild(t *testing.T) {
 	bin := buildShell(t)
 
-	cmd := exec.Command(bin)
+	cmd := exec.Command(bin, "-i")
 	// Own process group, so that we can signal it like the terminal does
 	cmd.SysProcAttr = &syscall.SysProcAttr{Setpgid: true}
 	stdin, err := cmd.StdinPipe()
@@ -1221,3 +1237,114 @@ func TestShell_SIGINTKillsOnlyChild(t *testing.T) {
 		t.Errorf("child was not interrupted (took %v)", elapsed)
 	}
 }
+
+func TestExecInput_PassesStdin(t *testing.T) {
+	r, w, err := os.Pipe()
+	if err != nil {
+		t.Fatal(err)
+	}
+	origStdin := os.Stdin
+	os.Stdin = r
+	defer func() {
+		os.Stdin = origStdin
+		r.Close()
+	}()
+
+	if _, err := w.WriteString("hello\n"); err != nil {
+		t.Fatal(err)
+	}
+	w.Close()
+
+	out := filepath.Join(t.TempDir(), "out")
+	t.Setenv("GOSH_TEST_OUT", out)
+	if err := execInput(`sh -c 'read x; printf %s "$x" > "$GOSH_TEST_OUT"'`); err != nil {
+		t.Fatal(err)
+	}
+	got, err := os.ReadFile(out)
+	if err != nil {
+		t.Fatal(err)
+	}
+	if string(got) != "hello" {
+		t.Errorf("command read %q from stdin, want %q", got, "hello")
+	}
+}
+
+func TestExitStatus(t *testing.T) {
+	tests := []struct {
+		input string
+		want  int
+	}{
+		{"true", 0},
+		{"false", 1},
+		{`sh -c "exit 42"`, 42},
+		{`sh -c "kill -TERM \$\$"`, 128 + 15},
+		{"gosh-no-such-command", 127},
+		{"cd /gosh-no-such-dir", 127},
+	}
+	for _, tc := range tests {
+		if got := exitStatus(execInput(tc.input)); got != tc.want {
+			t.Errorf("exitStatus(execInput(%q)) = %d, want %d", tc.input, got, tc.want)
+		}
+	}
+	if got := exitStatus(errors.New("other")); got != 1 {
+		t.Errorf("exitStatus(other error) = %d, want 1", got)
+	}
+}
+
+func TestRunScript(t *testing.T) {
+	origDir, _ := os.Getwd()
+	defer os.Chdir(origDir)
+
+	dir := t.TempDir()
+	script := "#!/usr/bin/gosh\n" +
+		"# comment\n" +
+		"\n" +
+		"cd " + dir + "\n" +
+		"  # indented comment\n" +
+		"touch first\n" +
+		"false\n" +
+		"touch second" // no trailing newline
+	if got := runScript(strings.NewReader(script)); got != 0 {
+		t.Errorf("runScript() = %d, want 0", got)
+	}
+	for _, name := range []string{"first", "second"} {
+		if _, err := os.Stat(filepath.Join(dir, name)); err != nil {
+			t.Errorf("expected %s to be created: %v", name, err)
+		}
+	}
+
+	// The status of the last command is returned
+	if got := runScript(strings.NewReader("true\nsh -c 'exit 3'\n")); got != 3 {
+		t.Errorf("runScript() = %d, want 3", got)
+	}
+}
+
+func TestRun_Options(t *testing.T) {
+	tests := []struct {
+		args []string
+		want int
+	}{
+		{[]string{"-c", "true"}, 0},
+		{[]string{"-c", "false"}, 1},
+		{[]string{"-l", "-c", "sh -c 'exit 5'"}, 5},
+		{[]string{"-c"}, 2},
+		{[]string{"-x"}, 2},
+		{[]string{"/gosh/no/such/script"}, 127},
+	}
+	for _, tc := range tests {
+		if got := run(tc.args); got != tc.want {
+			t.Errorf("run(%q) = %d, want %d", tc.args, got, tc.want)
+		}
+	}
+}
+
+func TestReadLine_DoesNotReadAhead(t *testing.T) {
+	r := strings.NewReader("first\nsecond\n")
+	line, err := readLine(r)
+	if line != "first" || err != nil {
+		t.Fatalf("readLine() = %q, %v", line, err)
+	}
+	if r.Len() != len("second\n") {
+		t.Errorf("readLine() consumed more than one line, %d bytes left", r.Len())
+	}
+}