What problem does it solve?
Provides a structured blueprint to create, integrate, and test new Sidecar plugins by detailing the plugin interface, lifecycle management, and UI rendering considerations. This guide helps plugin authors quickly scaffold, implement, and register plugins within the Sidecar architecture.
Core Features & Use Cases
- Architecture overview: Bubble Tea model, Registry, Plugin contract, Context, Keymap, and Event Bus.
- Lifecycle guidance: Registration → Init → Start → Update → View → Focus/Blur → Stop, with degradation and error handling strategies.
- Interop and rendering notes: external editor integration, error handling, determinism, and layout constraints to ensure stable rendering and predictable hints.
- Quick Start pattern: steps to scaffold a plugin package, implement the Plugin interface, and wire it into the app for loading.
Quick Start
Create a new internal/plugins/<id>/ directory, implement the plugin.Plugin interface, register it in cmd/sidecar/main.go, and start Sidecar to load your plugin.