Skip to content

plugins.en.md

Latest commit

 

History

History
78 lines (67 loc) · 4.53 KB

plugins.en.md

File metadata and controls

78 lines (67 loc) · 4.53 KB
Raw

Plugin Development Guide (authoritative text: the TUI Profile)

Documentation index · 简体中文

This document has been merged with the in-repo TUI Profile (tui-profile/): Plugin Admission and Development Guide

The ecosystem entry points and seam stability reference below are kept here for quick reference; the authoritative status and compatibility agreement live in the admission & development guide.

Ecosystem entry points

  • Interface & compatibility agreement / Plugin development guide: Terminal Interactive Ecosystem Plugin Admission and Development Guide (admission spec, seams, contracts, verification checklist).
  • Organization: dsh-tui-ecosystem (home of community plugins and templates).
  • Template repository: plugin-template (start from the template and ship a plugin in minutes).
  • Reference implementation: dsh-working-activity (live working-status line with dual outlets: TUI prompt slot + workingActivity session projection).

Seam stability reference

An informal maturity grading to help plugin authors gauge investment; the authoritative status and compatibility agreement live in the admission & development guide:

Tier Seams
Stable candidate (shape frozen; breaking changes go through a minor-version deprecation warning before removal) VI settings sections · VIII full-screen scenes · X managed dialogs · XI status line · XII keyboard shortcuts · XIII entry renderers
Experimental (may still shift with dsh-std / the TUI Profile) IX decision events · toast notifications (ctx.tuiToast, new) · Side panels (ctx.tuiPanels, full panel + compact row, experimental)
Upstream-tracked (stability owned by the cordis / dsh mechanisms underneath) I session events · II official prompt slots · III bundled skills · IV themes · V system-prompt sections · VII profile composition

Also an experimental public surface:

  • @deepseek-harness-tui/dsh-tui/api (types-only entry).

  • Side panels (experimental, §18): ctx.tuiPanels.register({ apiVersion: 1, id, title, icon?, component | compact }) registers a right-sidebar panel (the host prefixes <pluginId>:; ≤4 panels per plugin, ≤32 globally; open() is rate-limited to once per 5s; 3 consecutive crashes disable the panel for the session). Of the two render slots — the full panel (component) and the compact row (compact, 1–3 lines) — compact is descriptor-validated only this phase and not mounted yet; sendToChat requires the panels.chat.attach grant (a later version) and currently always returns false with a one-time hint. Types live at @deepseek-harness-tui/dsh-tui/panels and ./api.

  • The @deepseek-harness-tui/dsh-tui/test-utils subpath and ctx.tuiPluginHost.grants.corrupt were removed in the adapter layering refactor (#705).

  • grants is now the narrower HostGrantFacade; see that PR for migration details.

  • On TuiSceneProps.channel (ChannelUi), minimal / setMinimal() were renamed to minimalUi / setMinimalUi(); the old names stay as deprecated aliases reading and writing the same Minimal UI switch, so existing full-screen scene plugins keep working. That switch only trims interface decoration and is unrelated to the kernel minimal agent preset (极简模式). Removal condition (decidable): v0.13 — the rename and deprecated aliases first ship in v0.12.0, leaving one released minor-version deprecation window. At that cut, scan the scene-plugin consumption surface (this repo's src/** re-exports and every plugin on the dsh-tui-ecosystem org that reaches the port through TuiSceneProps.channel) for .minimal / .setMinimal(: zero callers means both aliases and the 'setMinimal': 'mutate' row in ui-policy.ts are deleted in v0.13; any remaining caller is migrated within that same release rather than postponing the removal again.

  • The core repository remains independent; community plugins live in their own repos.

  • The organization only maintains the listing and admission rules — it does not endorse or warrant the functionality, quality, or safety of community plugins.

  • Plugin authors keep full ownership of their repositories and are responsible for their maintenance and security.