shell

README

shell-prompt

To start an embedded shell-like prompt, type and run:

$ go run ./examples/shell-mode/ sh

See also: shell-mode app.

It looks like:

and

Type exit, quit, or shortcut CTRL-D to terminate the prompt session.

shell-prompt is powered by https://github.com/c-bata/go-prompt.

Backstage

Simply add shell.WithShellModule() to your cmdr entry

func Entry() {
	if err := cmdr.Exec(buildRootCmd(),
		shell.WithShellModule(),
	); err != nil {
		logrus.Fatalf("error: %+v", err)
	}
}

Documentation

Index

• Variables
• func ExecuteAndGetResult(s string) string
• func WithShellModule() cmdr.ExecOption

Variables

var LivePrefixState struct {
	LivePrefix string
	IsEnable   bool
}

LivePrefixState is a struct for auto-completion

Functions

func ExecuteAndGetResult

func ExecuteAndGetResult(s string) string

ExecuteAndGetResult executes an command line string `s` and capture its outputs.

func WithShellModule

func WithShellModule() cmdr.ExecOption

WithShellModule adds `shell` sub-command to cmdr system