@vibe-ctl/plugin-api
v1.0.0-alpha.0
Published
Plugin contract for vibe-ctl.
Readme
@vibe-ctl/plugin-api
The public plugin contract for vibe-ctl. This is the single package third-party plugin authors install from npm.
pnpm add @vibe-ctl/plugin-apiWhat's in here
Plugin— abstract class plugins extendPluginContext— thectxobject injected by the runtimePluginManifestSchema— Zod schema forplugin.jsonVibeEvents/VibeServices— declaration-merging surfaces- Widget, command, service, sync, mesh, UI, permission, and RPC types
- React hooks:
useWidgetConfig,useWidgetPlugin,useService,useUI,useAsync
Specs
The authoritative contract lives in specs/:
../../docs/specs/00-overview.md— vision and architecture../../docs/specs/01-plugin-system.md— plugin contract (this package)../../docs/specs/02-kernel-runtime.md— sync model the runtime implements
Implementation note
This package is types-first. The ctx.* members are type declarations only —
real implementations are injected by @vibe-ctl/runtime at activation time.
Runtime stubs throw if invoked directly outside a plugin host.
License
MIT
