Initial commit.

Author: abiosoft

.gitignore

@@ -0,0 +1 @@
+example/example

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Abiola Ibrahim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,80 @@
+# ishell
+ishell is an interactive shell library for creating interactive cli applications.
+
+[![Documentation](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](https://godoc.org/github.com/abiosoft/ishell)
+
+### Usage
+
+```go
+import "github.com/abiosoft/ishell"
+
+func main(){
+    // create new shell.
+    shell := ishell.NewShell()
+
+	// display welcome info.
+	shell.Println("Sample Interactive Shell")
+
+	// register a function for "exit" command.
+	shell.Register("exit", func(cmd string, args []string) (string, error) {
+		shell.Stop()
+		return "bye!", nil
+	})
+
+	// start shell
+	shell.Start()
+}
+```
+Execution
+```
+Sample Interactive Shell
+>> exit
+bye!
+```
+
+#### Let's do more.
+```go
+// simulate an authentication
+shell.Register("login", func(cmd string, args []string) (string, error) {
+    // get username
+	shell.Println("Username:")
+	username, _ := shell.ReadLine()
+
+    // get password. Does not echo characters.
+	shell.Println("Password:")
+	password := shell.ReadPassword(false)
+
+	... // do something with username and password
+
+    return "Authentication Successful.", nil
+})
+```
+Execution
+```
+Username:
+>> someusername
+Password:
+>>
+Authentication Successful.
+```
+Check example code for more.
+
+### Note
+ishell is in active development and can still change significantly.
+
+### Roadmap (in no particular order)
+* Support multiline inputs.
+* Handle ^C interrupts.
+* Support coloured outputs.
+* Testing, testing, testing.
+
+### Contribution
+1. Create an issue to discuss it.
+2. Send in Pull Request.
+
+### License
+MIT
+
+### Credits
+* github.com/flynn/go-shlex for splitting input into command and args.
+* github.com/howeyc/gopass for reading passwords.

errors.go

@@ -0,0 +1,64 @@
+package ishell
+
+type ErrLevel int
+
+const (
+	LevelWarn ErrLevel = iota + 1
+	LevelStop
+	LevelExit
+	LevelPanic
+)
+
+var (
+	errNoHandler = WarnErr("No handler registered for input.")
+)
+
+// ShellError is an interractive shell error
+type shellError struct {
+	err   string
+	level ErrLevel
+}
+
+func (s shellError) Error() string {
+	return s.err
+}
+
+// NewErr creates a new error with specified level
+func NewErr(err string, level ErrLevel) error {
+	return shellError{
+		err:   err,
+		level: LevelWarn,
+	}
+}
+
+// WarnErr creates a Warn level error
+func WarnErr(err string) error {
+	return shellError{
+		err:   err,
+		level: LevelWarn,
+	}
+}
+
+// StopErr creates a Stop level error. Shell stops if encountered.
+func StopErr(err string) error {
+	return shellError{
+		err:   err,
+		level: LevelStop,
+	}
+}
+
+// ExitErr creates a Exit level error. Program terminates if encountered.
+func ExitErr(err string) error {
+	return shellError{
+		err:   err,
+		level: LevelExit,
+	}
+}
+
+// PanicErr creates a Panic level error. Program panics if encountered.
+func PanicErr(err string) error {
+	return shellError{
+		err:   err,
+		level: LevelPanic,
+	}
+}

example/main.go

@@ -0,0 +1,42 @@
+package main
+
+import (
+	"strings"
+
+	"github.com/abiosoft/ishell"
+)
+
+func main() {
+	shell := ishell.NewShell()
+
+	// display info
+	shell.Println("Sample Interactive Shell")
+
+	// handle exit
+	shell.Register("exit", func(cmd string, args []string) (string, error) {
+		shell.Println("Do you want to do more ? y/n:")
+		line, _ := shell.ReadLine()
+		if strings.ToLower(line) == "y" {
+			doMore(shell)
+		}
+		shell.Stop()
+		return "bye!", nil
+	})
+
+	// start shell
+	shell.Start()
+}
+
+func doMore(shell *ishell.Shell) {
+	shell.Stop()
+
+	// prompt for input
+	shell.Println("Username:")
+	username, _ := shell.ReadLine()
+	shell.Println("Password:")
+	password := shell.ReadPassword(false)
+
+	// do something with username and password
+	shell.Println("Your inputs were", username, "and", password+".")
+
+}