Skip to content

Plugins

BokeBox splits replaceable capabilities into four plugin kinds that share plugin-kit (enable/disable, config, manifest loading). Business APIs differ by capability.

Four kinds

KindRoleDirectoryDocs
SourceIngest → unified SourceArtifactstorage/plugins/source/Guide · Dev
ASRSpeech-to-textstorage/plugins/asr/Guide · Dev
TTSText-to-speechstorage/plugins/tts/Guide · Dev
ScheduleTimed candidate URLsstorage/plugins/schedule/Guide · Dev

Principles

  1. Core consumes contracts only — high-risk fetch / third-party charts stay optional plugins
  2. Least privilege by defaultriskLevel: high forces default off
  3. Hot plug — drop into directory or zip upload, then Settings rescan
  4. Runnable examples — repo examples/*-plugin-*

Management

  • Web: Settings → Plugins
  • API: /api/{source|asr|tts|schedule}-plugins (list / rescan / toggle / config / install)

Install

Next

Read the product guide for architecture, then the dev guide to implement.