README
¶
PlugKit
PlugKit to stupidly simple, stream-capable plugin runtime for Go.
No gRPC. No protobuf. No codegen.
Just structs, CBOR, pipes and a handshake.
✨ Why PlugKit?
PlugKit is a micro-framework that lets you:
- run plugins as separate processes
- communicate with them over
stdin/stdout - pass arbitrary Go structs encoded with CBOR
- use bidirectional message routing (the plugin can speak first!)
- gracefully terminate a plugin whenever you want (
Finish)
It's like HashiCorp’s go-plugin, but:
- without the pain
- without reflection
- without type registries
- with streaming message support 😎 (in future)
🧪 Status
PlugKit is under active development.
The API will evolve slightly, but the core already works:
- ✅ Running plugins as separate processes
- ✅ Bidirectional communication (host <-> plugin)
- ✅ CBOR serialization (
fxamacker/cbor) - ✅ Handling multiple message types
- ✅
Finish()with exit code support - ⏳ Handshake with capabilities negotiation
- ⏳ Unit tests
- ⏳ API documentation
Documentation
¶
Index ¶
- func MustRaw(v any) cbor.RawMessage
- type Client
- func (c *Client) DownloadAndStart()
- func (h *Client) HandleMessageType(name string, handler func([]byte))
- func (h *Client) Init()
- func (c *Client) Kill()
- func (h *Client) Respond(t string, v any)
- func (c *Client) RunCommand(name string, v any)
- func (c *Client) SetCommand(command string)
- func (c *Client) StartLocal()
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func MustRaw ¶
func MustRaw(v any) cbor.RawMessage
Types ¶
type Client ¶
type Client struct {
Handlers map[string]func([]byte)
Wg *sync.WaitGroup
// contains filtered or unexported fields
}
func (*Client) DownloadAndStart ¶
func (c *Client) DownloadAndStart()
func (*Client) HandleMessageType ¶
func (*Client) RunCommand ¶
func (*Client) SetCommand ¶
func (*Client) StartLocal ¶
func (c *Client) StartLocal()
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.