plugkit

package module
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 10, 2025 License: MIT Imports: 2 Imported by: 0

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:

  • create and run plugins as separate processes (we call them simply plugs)
  • communicate with them over stdin/stdout
  • pass arbitrary Go structs encoded with CBOR
  • use bidirectional message routing
  • gracefully terminate a plug 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

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateAndRunPlug added in v0.0.3

func CreateAndRunPlug(handlers *[]options.CommandHandler) error

CreateAndRunPlug creates functional-like plug and runs it

func NewBiDiClient added in v0.0.3

func NewBiDiClient()

func NewClient

func NewClient()

func NewBiDiPlug() {}

func NewPlug added in v0.0.3

func NewPlug() *plug.Plug

NewPlug returns new empty plug

Types

This section is empty.

Directories

Path Synopsis
examples

Jump to

Keyboard shortcuts

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