api

Documentation

Index

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

Constants

const (
	PluginsDir    = "./plugins"
	CmdSymbolName = "Commands"
	DefaultPrompt = "gosh>"
)

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