diff --git a/CHANGELOG.md b/CHANGELOG.md index f935d3d..9970be8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed -- Corrected OpenCode v2 plugin configuration paths and schema references in the English and Russian installation guides. +- Corrected OpenCode v2 installation and configuration examples, documented every consumed `tui` field, and removed screenshots that no longer represented v3 defaults or output. ## [3.1.0] - 2026-10-21 diff --git a/README.md b/README.md index b724d41..395b08d 100644 --- a/README.md +++ b/README.md @@ -18,21 +18,11 @@ | Runtime | Bun `>=1.3.0` | | Maintainer checks | `bun install --frozen-lockfile && bun run typecheck && bun test && bun run build:all && bun run verify:package` | -## Screenshots - -The plugin renders agent categories and details inside the OpenCode terminal UI sidebar. - -![All categories collapsed](assets/categories-collapsed.png) - -![Categories expanded](assets/categories-expanded.png) - -![Agent details](assets/agent-details.png) ## Summary -- Displays OpenCode agents in the OpenCode sidebar. - Reads agents from `oh-my-openagent.json` through a normalized provider boundary; the seam permits a future native OpenCode source without claiming universal discovery today. -- Groups agents into neutral categories such as primary, subagents, built-in, project, global, custom, disabled, hidden, and other. +- Groups agents by source-owned categories. The generic order is neutral, while the current OhMyOpenAgent provider retains its legacy lifecycle mapping. - Supports collapsible category sections and a collapsible main sidebar panel. - Shows provider, model, variant, fallback, and disabled-agent information according to display settings. - Supports compact and split row layouts for different terminal widths. @@ -111,7 +101,8 @@ sections are OhMyOpenAgent data. `src/providers/omo.ts` normalizes that data for the sidebar. The provider seam permits a future native OpenCode source, but native or universal agent discovery is not part of this release. -Smallest useful configuration: +Plugin settings belong in the existing OhMyOpenAgent file; do not replace its +top-level agent data. A minimal plugin-specific override is: ```json { @@ -123,7 +114,7 @@ Smallest useful configuration: } ``` -Full documented shape: +Complete `tui` shape consumed by this plugin: ```json { @@ -132,11 +123,18 @@ Full documented shape: "name_width": 18, "poll_interval_ms": 2000, "title": "Agents", + "agent_categories": { + "local-helper": "Custom" + }, "category_order": ["Primary", "Subagents", "Built-in", "Project", "Global", "Custom", "Disabled", "Hidden", "Other"], + "default_collapsed": [], "model_display": "details-only", "show_provider": true, "show_variant_in_details": false, "show_disabled": "dimmed", + "show_team_status": true, + "show_tmux_status": true, + "default_agents_collapsed": false, "agent_row_mode": "compact", "symbols": "unicode", "provider_aliases": { @@ -176,6 +174,12 @@ Supported values: - `show_disabled`: `"hidden"`, `"dimmed"`, or `"grouped"`. - `agent_row_mode`: `"compact"` or `"split"`. - `symbols`: `"unicode"` or `"ascii"`. +- `agent_categories`: maps an agent name to a category; an explicit category on + the agent still takes precedence. +- `default_collapsed`: category names collapsed on first render. +- `default_agents_collapsed`: collapses the entire agent section on first render. +- `show_team_status` and `show_tmux_status`: control the optional OhMyOpenAgent + status rows. OpenCode v2 sidebar contribution order follows package order in the host `plugins` list. @@ -235,7 +239,6 @@ team 2/4 ```text . -├── assets/ # Local screenshots used by this README ├── dist/ # Built package output ├── src/ │ ├── agents/ # Normalized agent types, grouping, merge logic diff --git a/README.ru.md b/README.ru.md index a1f6be3..68437f7 100644 --- a/README.ru.md +++ b/README.ru.md @@ -18,21 +18,11 @@ | Runtime | Bun `>=1.3.0` | | Проверки maintainer | `bun install --frozen-lockfile && bun run typecheck && bun test && bun run build:all && bun run verify:package` | -## Скриншоты - -Plugin отображает agent categories и details внутри sidebar терминального UI OpenCode. - -![All categories collapsed](assets/categories-collapsed.png) - -![Categories expanded](assets/categories-expanded.png) - -![Agent details](assets/agent-details.png) ## Сводка -- Показывает OpenCode agents в OpenCode sidebar. - Читает agents из `oh-my-openagent.json` через normalized provider boundary; seam допускает будущий native OpenCode source, но текущий release не заявляет universal discovery. -- Группирует agents в нейтральные категории: primary, subagents, built-in, project, global, custom, disabled, hidden и other. +- Группирует agents по категориям source. Generic order нейтрален, а текущий OhMyOpenAgent provider сохраняет legacy lifecycle mapping. - Поддерживает сворачиваемые category sections и сворачиваемый главный sidebar panel. - Показывает provider, model, variant, fallback и disabled-agent информацию согласно display settings. - Поддерживает compact и split row layouts для разных terminal widths. @@ -111,7 +101,8 @@ Top-level sections `agents`, `agent_order`, `disabled_agents`, `team_mode` и sidebar. Provider seam допускает будущий native OpenCode source, но native или universal agent discovery не входят в этот release. -Минимальная полезная конфигурация: +Настройки plugin нужно добавлять в существующий файл OhMyOpenAgent, не заменяя +его top-level agent data. Минимальный plugin-specific override: ```json { @@ -123,7 +114,8 @@ universal agent discovery не входят в этот release. } ``` -При использовании текущего OhMyOpenAgent bootstrap source оставьте legacy category order, если хотите привычную группировку: +При использовании текущего OhMyOpenAgent bootstrap source оставьте legacy +category order, если хотите привычную группировку: ```json { @@ -134,7 +126,7 @@ universal agent discovery не входят в этот release. } ``` -Полная документированная форма: +Полная форма `tui`, которую использует этот plugin: ```json { @@ -143,11 +135,18 @@ universal agent discovery не входят в этот release. "name_width": 18, "poll_interval_ms": 2000, "title": "Agents", + "agent_categories": { + "local-helper": "Custom" + }, "category_order": ["Primary", "Subagents", "Built-in", "Project", "Global", "Custom", "Disabled", "Hidden", "Other"], + "default_collapsed": [], "model_display": "details-only", "show_provider": true, "show_variant_in_details": false, "show_disabled": "dimmed", + "show_team_status": true, + "show_tmux_status": true, + "default_agents_collapsed": false, "agent_row_mode": "compact", "symbols": "unicode", "provider_aliases": { @@ -176,6 +175,12 @@ universal agent discovery не входят в этот release. - `show_disabled`: `"hidden"`, `"dimmed"` или `"grouped"`. - `agent_row_mode`: `"compact"` или `"split"`. - `symbols`: `"unicode"` или `"ascii"`. +- `agent_categories`: сопоставляет имя agent с category; явная category в + настройках самого agent имеет приоритет. +- `default_collapsed`: categories, свёрнутые при первом render. +- `default_agents_collapsed`: сворачивает весь agent section при первом render. +- `show_team_status` и `show_tmux_status`: управляют опциональными status rows + OhMyOpenAgent. В OpenCode v2 порядок sidebar contributions определяется порядком packages в host-списке `plugins`. @@ -235,7 +240,6 @@ team 2/4 ```text . -├── assets/ # Local screenshots для README ├── dist/ # Собранный package output ├── src/ │ ├── agents/ # Normalized agent types, grouping, merge logic diff --git a/assets/agent-details.png b/assets/agent-details.png deleted file mode 100644 index f08ba03..0000000 Binary files a/assets/agent-details.png and /dev/null differ diff --git a/assets/categories-collapsed.png b/assets/categories-collapsed.png deleted file mode 100644 index 2074ddf..0000000 Binary files a/assets/categories-collapsed.png and /dev/null differ diff --git a/assets/categories-expanded.png b/assets/categories-expanded.png deleted file mode 100644 index c7b6709..0000000 Binary files a/assets/categories-expanded.png and /dev/null differ