shell

package

v0.0.0-...-c996816 Latest Latest Go to latest Published: Jul 3, 2023 License: ISC Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package shell is built above the x/term library and provides friendlier bindings.

This section is empty.

This section is empty.

This section is empty.

type Query struct {
	// contains filtered or unexported fields
}

Query represents a single command line sent by the user.

func (q *Query) Argv() []string

Argv returns an array of whitespace separated arguments from the user's command.

func (q *Query) Exit()

Exit stops the interactive shell after the handler returns.

func (q *Query) Line() string

Line returns the line sent by the user

func (q Query) Print(a ...any) (int, error)

Print writes the string to the terminal

func (q *Query) Printf(format string, a ...any) (int, error)

func (q *Query) Println(a ...any) (int, error)

Println writes the string to the terminal then adds a newline.

type Shell struct {
	// contains filtered or unexported fields
}

func New(prompt string, handler func(*Query) error) *Shell

func (s *Shell) Run() error