api

package

v0.1.0-beta Latest Latest Go to latest Published: Jan 10, 2020 License: MIT 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

Repository

github.com/Merith-TK/gosh

Documentation ¶

Index ¶

Constants
Variables
func GetPrompt(ctx context.Context) string
func GetStdout(ctx context.Context) io.Writer
type Command
type Commands
type Module

Constants ¶

View Source

const (
	CmdSymbolName = "Commands"
	DefaultPrompt = "gosh>"
)

Variables ¶

View Source

var PluginsDir = plugins()

Functions ¶

func GetPrompt ¶

func GetPrompt(ctx context.Context) string

func GetStdout ¶

func GetStdout(ctx context.Context) io.Writer

Types ¶

type Command ¶

type Command interface {
	Name() string
	Usage() string
	ShortDesc() string
	LongDesc() string
	Exec(context.Context, []string) (context.Context, error)
}

Command represents an executable a command

type Commands ¶

type Commands interface {
	Module
	Registry() map[string]Command
}

Commands a plugin that contains one or more command

type Module ¶

type Module interface {
	Init(context.Context) error
}

Module a plugin that can be initialized

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL