Expand description
Plugin manifest types, discovery, and validation.
A plugin is a directory under the plugins root whose name equals its manifest
id, containing a manifest.json and the executable its entry points name.
Discovery is deliberately forgiving: one broken manifest produces a warning
and is skipped, never blocking the discovery of its neighbours. A plugin is
never spawned as a side effect of discovery — the host spawns only what the
enabled set names, which is what makes “lands disabled” structural.
Structs§
- Action
Contribution - One action a plugin contributes to the command palette when it declares
the
KIND_ACTION_CONTRIBUTORkind. - Discovered
Plugin - A plugin that passed validation, with confinement-checked paths.
- Discovery
Warning - Why a candidate plugin directory was skipped.
- Overlay
Capability - Capabilities an
overlay-kind manifest may claim. - Plugin
Entry Point - One named executable entry point.
commandis relative to the plugin directory only — never a PATH lookup, never allowed to escape the directory (enforced bydiscover_plugins). - Plugin
Manifest - A parsed
manifest.json. - Setting
Schema Entry - One typed setting declared by a plugin’s settings schema.
- Status
BarWidget Kind - The
statusBarWidgetmanifest block: how a status-bar-widget plugin presents itself and what the user can configure.
Enums§
- Plugin
Activation - Activation policy declared by the manifest.
- Setting
Type - A setting’s value type, as declared in a manifest’s settings schema.
Constants§
- ENTRY_
POINT_ ACTION_ CONTRIBUTOR - Entry-point map key for the
KIND_ACTION_CONTRIBUTORkind. - ENTRY_
POINT_ OVERLAY - Entry-point map key for the
KIND_OVERLAYkind. - ENTRY_
POINT_ PANEL - Entry-point map key for the
KIND_PANELkind. - ENTRY_
POINT_ STATUS_ BAR_ WIDGET - Entry-point map key for the
KIND_STATUS_BAR_WIDGETkind. - KIND_
ACTION_ CONTRIBUTOR - The action-contributor plugin kind: the plugin contributes entries to the command palette.
- KIND_
OVERLAY - The overlay plugin kind: the plugin owns a persistent surface drawn over
the terminal through the
SetOverlay/ClearOverlayprotocol commands (design: docs/plans/2026-09-24-overlay-plugin-design.md). Phase 1 is display-only;interactiverequires theoverlay.interactivecapability and is forced off without it. - KIND_
PANEL - The panel plugin kind: the plugin pushes markdown panel content through
the
SetPanel/ClearPanelprotocol commands (the same surface a tab script’sSetPaneldrives), rendered in the Settings plugins section. - KIND_
STATUS_ BAR_ WIDGET - The status-bar-widget plugin kind. Unknown kinds in a manifest skip the whole plugin with a visible warning rather than loading partially.
Functions§
- discover_
plugins - Scan a plugins root for valid plugin directories.
- validate_
settings - Validate persisted settings against a manifest schema.