module

Documentation

Index

• func IsLoaded(id string) bool
• func Load(cfg config.Config, client *openai.Client, modules ...Module) error
• func LoadCompiledPlugins() error
• func LoadPlugin(m Module) error
• func UpdateConfig(cfg config.Config)
• type CommandResult
  • func ExecuteCommand(command, args, body string) (bool, *CommandResult)
  • func HelpCommand() (bool, *CommandResult)
• type IntervalPrompt
• type Module
  • func GetModuleForPlugin(p Plugin) Module
• type Plugin
  • func OpenPlugin(path string) (Plugin, error)

Functions

func IsLoaded

func IsLoaded(id string) bool

func Load

func Load(cfg config.Config, client *openai.Client, modules ...Module) error

func LoadCompiledPlugins

func LoadCompiledPlugins() error

func LoadPlugin

func LoadPlugin(m Module) error

func UpdateConfig

func UpdateConfig(cfg config.Config)

Types

type CommandResult

type CommandResult struct {
	Error  error
	Prompt string
}

func ExecuteCommand

func ExecuteCommand(command, args, body string) (bool, *CommandResult)

func HelpCommand

func HelpCommand() (bool, *CommandResult)

type IntervalPrompt

type IntervalPrompt interface {
	IntervalPrompt() string
}

IntervalPrompt allows a module to inject a prompt into the interval prompt

type Module

type Module interface {
	Load(config.Config, *openai.Client) error
	UpdateConfig(config.Config)
	ID() string
	Prompt() string
	Execute(args, body string) (string, error)
}

func GetModuleForPlugin

func GetModuleForPlugin(p Plugin) Module

type Plugin

type Plugin interface {
	ID() string
	Example() string
	Execute(map[string]any) (map[string]any, error)
}

func OpenPlugin

func OpenPlugin(path string) (Plugin, error)