This folder explains how opencode-subagent-statusline works: what problem it solves, how it integrates with OpenCode, how it processes subagent events, and how the project is maintained.
The documentation is written for two audiences:
- Plugin users, who want to install, configure, and understand the TUI surface.
- Contributors, who need to understand the architecture, tests, and internal rules before changing code.
If this is your first time in the repository, read in this order:
- Overview
- Installation and usage
- Architecture
- Event flow
- State model and counters
- Rendering and deduplication
- TUI interface
- Advanced configuration
- Development and testing
- Troubleshooting
| Document | Purpose |
|---|---|
| 01-overview.md | Understand what the plugin does and its main pieces. |
| 02-installation-and-usage.md | Install the plugin in OpenCode and use the sidebar. |
| 03-architecture.md | Understand the code modules and how they connect. |
| 04-event-flow.md | Follow the path from an OpenCode event to a visible row. |
| 05-state-model-and-counters.md | Explain StatuslineState, ChildSessionState, sources, and totalExecuted. |
| 06-rendering-and-deduplication.md | Explain row collapse, visibility, and the difference between internal state and UI. |
| 07-tui-interface.md | Document the sidebar, footer, navigation, and commands. |
| 08-advanced-configuration.md | Environment variables, state files, debug logs, and paths. |
| 09-development-and-testing.md | Commands, test strategy, coverage boundaries, and smoke tests. |
| 10-troubleshooting.md | Common cases: plugin not visible, stale cache, missing tokens, and debugging. |
Created documents:
00-index.md01-overview.md02-installation-and-usage.md03-architecture.md04-event-flow.md05-state-model-and-counters.md06-rendering-and-deduplication.md07-tui-interface.md08-advanced-configuration.md09-development-and-testing.md10-troubleshooting.md
Not part of the current numbered set:
- publication and release documentation, which remains intentionally pending for a future pass if needed.