PluginManifest

Properties

adapters?

optional adapters?: string | string[]

app?

optional app?: PluginAppConfig

Desktop-app provider config. For providers that ship as a native macOS app with a local HTTP API rather than a CLI (e.g. Ollama, Osaurus). When present, onboarding renders a Download → Open → Models flow instead of the CLI Install → Sign in → Ready flow.

appScope?

optional appScope?: string

Defined in: plugin.ts:148

Which app the plugin applies to: recursive, financial, or shared.

author?

optional author?: string | { name?: string; url?: string; }

Defined in: plugin.ts:138

Author attribution — a plain string or { name, url }.

automations?

optional automations?: string | string[]

Defined in: plugin.ts:184

bundledOptIn?

optional bundledOptIn?: boolean

Defined in: plugin.ts:215

When true, the bundled copy is marketplace-only — skills/rules/hooks/tools do not load until the user installs the plugin into ~/.recursive/…/installed/. Adapter plugins stay bundle-scanned so onboarding can browse them without copying; use this for optional integrations (Slack, Memory, verify hooks).

category?

optional category?: string

Defined in: plugin.ts:144

Marketplace category.

cli?

optional cli?: PluginCliConfig

Defined in: plugin.ts:253

How to probe whether this plugin’s CLI is installed. bin defaults to the adapter’s terminal.command; versionArgs (e.g. ['--version']) capture a version string when present. Used by GET /api/adapters/cli-status.

client_lifecycle?

optional client_lifecycle?: Record<string, ClientLifecycleHandlerDeclaration>

Defined in: plugin.ts:207

color?

optional color?: string

Defined in: plugin.ts:141

commands?

optional commands?: string | string[]

Defined in: plugin.ts:183

Slash-command Markdown files contributed by the plugin.

comms?

optional comms?: string | string[]

Defined in: plugin.ts:156

Comms templates directory.

core?

optional core?: boolean

Defined in: plugin.ts:217

Core platform plugin — boot-synced and cannot be disabled in the UI.

data?

optional data?: PluginDataConfig

Defined in: plugin.ts:205

dependencies?

optional dependencies?: string[]

Defined in: plugin.ts:208

description?

optional description?: string

Defined in: plugin.ts:136

detect?

optional detect?: PluginDetectConfig

Defined in: plugin.ts:204

diagnoseCommand?

optional diagnoseCommand?: string

Defined in: plugin.ts:238

greetings?

optional greetings?: string | string[]

Defined in: plugin.ts:190

Session-greeting catalog JSON files. Each catalog is exposed as a greeting pack.

homepage?

optional homepage?: string

Defined in: plugin.ts:139

hooks?

optional hooks?: string | string[]

Defined in: plugin.ts:198

icon?

optional icon?: string

Defined in: plugin.ts:142

id

id: string

Defined in: plugin.ts:133

installCommand?

optional installCommand?: string

Defined in: plugin.ts:239

installUrl?

optional installUrl?: string

Defined in: plugin.ts:247

Docs / landing URL for installing this plugin’s CLI. Shown as a “learn more” link beside the install action (and as the fallback when no installCommand can be auto-run, e.g. a download page).

lifecycle?

optional lifecycle?: Record<string, LifecycleHandlerDeclaration>

Defined in: plugin.ts:206

loginCommand?

optional loginCommand?: string

Defined in: plugin.ts:236

Terminal-action catalog (declarative, resolved by the server’s resolveTerminalAction). Each is an interactive CLI command the platform can offer in a floating terminal sheet — surfaced as a one-click pill on plugin cards, settings rows, and error states.

loginCommand — (re)authenticate, e.g. codex login. Kind auth.
setupCommand — first-time / config setup, e.g. aws configure. Kind setup.
diagnoseCommand— health check / repair, e.g. gh auth status. Kind diagnose.
installCommand — install the CLI itself (pre-flight before auth). Kind install.
mcpLoginCommand — authenticate ONE downstream MCP server through this CLI, e.g. codex mcp login {{server}}. Kind mcp-auth.
mcpDiagnoseCommand — inspect a downstream MCP server’s connection state, e.g. claude mcp get {{server}}. Kind mcp-diagnose.

The two mcp* commands may contain a {{server}} placeholder, replaced with the failing MCP server’s configured name. A template that needs {{server}} is skipped when the adapter reported only an endpoint.

mcp?

optional mcp?: string | string[]

Defined in: plugin.ts:199

mcpDiagnoseCommand?

optional mcpDiagnoseCommand?: string

Defined in: plugin.ts:241

mcpLoginCommand?

optional mcpLoginCommand?: string

Defined in: plugin.ts:240

min_recursive_version?

optional min_recursive_version?: string

Defined in: plugin.ts:154

Minimum Recursive version this plugin supports; enforced at install.

name?

optional name?: string

Defined in: plugin.ts:134

npm?

optional npm?: object

Defined in: plugin.ts:260

npm install behavior for the plugin’s package.json dependencies. Lifecycle scripts (postinstall etc.) are disabled by default; a plugin that genuinely needs them declares "npm": { "scripts": true } and that fact is disclosed at install time.

scripts?

optional scripts?: boolean

onboarding?

optional onboarding?: PluginOnboardingConfig

Defined in: plugin.ts:279

Declarative onboarding shown after marketplace installation and from the plugin settings page. Unlike setupSequence, these steps may collect plugin settings or link to an external setup console.

platforms?

optional platforms?: string[]

Defined in: plugin.ts:152

OS allowlist (e.g. [“darwin”]); omit for all platforms.

private?

optional private?: boolean

Defined in: plugin.ts:150

Excluded from registry publishing.

providers?

optional providers?: string | string[]

Defined in: plugin.ts:196

Inference-provider catalog JSON. Each approved row becomes a connectable provider — no adapter code, since anything speaking the chat-completions protocol needs only an endpoint, an env var and a model list.

provides?

optional provides?: object

Defined in: plugin.ts:164

Structured provider declarations. Each key is a provider kind whose value is a ProvidesBlock, read by that kind’s registry:

sync_provider → core-sync discoverSyncProviders (encrypted-bytes transport)
auth_provider → core-identity discoverAuthProviders (pluggable identity/permission backend)
data_provider → reserved

Index Signature

[kind: string]: ProvidesBlock | undefined

auth_provider?

optional auth_provider?: ProvidesBlock

data_provider?

optional data_provider?: ProvidesBlock

sync_provider?

optional sync_provider?: ProvidesBlock

routes?

optional routes?: string | string[]

Defined in: plugin.ts:197

rules?

optional rules?: string | string[]

Defined in: plugin.ts:181

settings?

optional settings?: PluginSettingsSchema

Defined in: plugin.ts:203

setupCommand?

optional setupCommand?: string

Defined in: plugin.ts:237

setupSequence?

optional setupSequence?: PluginSetupStep[]

Defined in: plugin.ts:273

Ordered “getting started” steps, surfaced as a checklist after install and during onboarding. Each step reuses the terminal-action catalog kinds and, when command is omitted, the matching manifest command field.

skills?

optional skills?: string | string[]

Defined in: plugin.ts:180

soundDefaults?

optional soundDefaults?: Record<string, string>

Defined in: plugin.ts:179

Sound packs only — an explicit mapping from a notification event to a sound slug (the audio file’s stem). Lets a pack declare which of its sounds plays for each event when the user applies the pack in Notifications settings. Keys are the client’s NotificationSoundKeys (soundSessionStarted, soundSessionComplete, soundQuestionAsked, soundSessionError, soundAppOpen); the map may be partial. Any event left unmapped — or whose slug isn’t present in the pack — falls back to keyword-heuristic matching.