README
¶
gocommand
Gocommand is the simplest way to create a command line interface throw stdin/out for your Go application. It provides a simple way to read commands and arguments from the standard input and execute them.
Usage
Simple command read
package main
import (
"fmt"
"github.com/nessai1/gocommand"
)
func main() {
gocommand.ListenAndServe(func(cmd *gocommand.Command) error {
if cmd.Name == "exit" {
return gocommand.ErrGracefulExit
}
fmt.Printf("Command: %s\n", cmd.Name)
fmt.Printf("Arguments: %v\n", cmd.Args)
return nil
})
}
Output:
Prompting the user for input
Library allows you to ask user for input using the AskText and AskSecret functions
AskTextfunction asks the user for a text input and returns it as a stringAskSecretfunction asks the user for a sensitive data and returns it as a string
package main
import (
"fmt"
"github.com/nessai1/gocommand"
)
func main() {
gocommand.ListenAndServe(func(cmd *gocommand.Command) error {
if cmd.Name == "exit" {
return gocommand.ErrGracefulExit
}
if cmd.Name == "login" {
login, err := gocommand.AskText("Enter your username")
if err != nil {
return fmt.Errorf("cannot ask login: %w", err)
}
password, err := gocommand.AskSecret("Enter your password")
if err != nil {
return fmt.Errorf("cannot ask password: %w", err)
}
fmt.Printf("make authentification with login '%s' and password '%s'...\n", login, password)
}
return nil
})
}
Output:
Documentation
¶
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var ErrGracefulExit = fmt.Errorf("graceful exit")
Functions ¶
func AskSecret ¶
AskSecret prompts user to enter a secret, writes prompt to output as an anchor and separates it with a colon
func AskText ¶
AskText prompts user to enter a text, writes prompt to output as an anchor and separates it with a colon
func ListenAndServe ¶
ListenAndServe reads commands from input and calls handler for each command. If handler returns ErrGracefulExit, ListenAndServe stops without error message; If handler returns err != nil, ListenAndServe stops and print error message; If handler returns nil, ListenAndServe continues to read commands.
Types ¶
type Command ¶
type Command struct {
// Name first word of given command line
Name string
// Args arguments of written command, separated by spaces
Args []string
}
Command info about entered command
func ReadCommand ¶
ReadCommand prompts user to enter a command to input, writes command anchor to output
Example ¶
ListenAndServe(func(cmd *Command) error {
if cmd.Name == "exit" {
return ErrGracefulExit
}
fmt.Printf("Command: %s\n", cmd.Name)
fmt.Printf("Arguments: %v\n", cmd.Args)
return nil
})
Source Files