Repository navigation
Plugin API for custom sidebar panels #5971
Description
Summary
Provide an API that allows plugins to register custom sections/panels in the sidebar.
Motivation
Currently, plugins can extend OpenCode with tools, hooks, agents, and MCP configs - but have no way to surface custom UI in the sidebar. The sidebar is entirely controlled by OpenCode internals (MCPs, context usage, todos, etc.).
For plugins like oh-my-opencode, there are several things we'd want to display:
- Background agent task status (running/completed/failed)
- Custom metrics or state tracked by hooks
- Plugin-specific configuration status
- Agent availability/health indicators
Implemented API
// In @opencode-ai/plugin
interface SidebarPanelItem {
label: string
value?: string
status?: "success" | "warning" | "error" | "info"
}
interface SidebarPanel {
id: string
title: string
items: SidebarPanelItem[] | (() => SidebarPanelItem[])
}
interface Hooks {
// ... existing hooks
sidebar?: SidebarPanel[] | (() => SidebarPanel[])
}Usage Example
import { definePlugin } from "@opencode-ai/plugin"
export default definePlugin({
name: "my-plugin",
hooks: {
sidebar: [
{
id: "status",
title: "My Plugin Status",
items: [
{ label: "Version", value: "1.0.0" },
{ label: "Status", value: "Active", status: "success" }
]
}
]
}
})Dynamic Updates
Both sidebar and items can be functions for dynamic content. The sidebar polls every 5 seconds for updates:
hooks: {
sidebar: () => [{
id: "metrics",
title: "Live Metrics",
items: () => [
{ label: "Requests", value: String(requestCount) },
{ label: "Last Update", value: new Date().toLocaleTimeString() }
]
}]
}Implementation Details
- Server endpoint:
GET /plugin/sidebarreturns aggregated panels from all plugins - UI: Plugin panels render in the sidebar with collapse/expand support
- Polling: 5-second refresh interval with proper cleanup
- Error isolation: Individual plugin failures are logged but don't affect others
Metadata
Metadata
Assignees
Labels
No labels
Activity
z80dev commentedon Dec 29, 2025
First-pass implementation available in #6389
fatihdogmus commentedon Jan 12, 2026
that would be pretty nice since I wanted to add a status section where I can see my codex or claude code quota but wasn't able to. Claude code has somewhat customizable status bar, so this issue would be pretty neat.
mathisdev7 commentedon Jan 12, 2026
this is a really solid addition. persistent sidebar panels are exactly whats been missing for things like quota visibility
i ran into this problem deeply while working on arctic (a focused fork of opencode for plan-based usage visibility). one thing that became clear is that quota tracking only stays accurate when the client owns the request flow
sidebar hooks make a clean UX possible, but if plugins have to infer usage or rely on extra agent/tool calls, things get noisy or inaccurate fast
still, this API unlocks a lot of previously impossible UI
art-shen commentedon Jan 13, 2026
Yes, please enable OpenCode plugins to display additional helpful information in the sidebar or elsewhere!
Without this functionality, some plugins that could display available quota for requests or other important status information can’t be used efficiently.
Example of a feature request in a plugin that was closed as impossible at the moment:
NoeFabris/opencode-antigravity-auth#152
js-krinay commentedon Feb 24, 2026
Improvements
sync.data.widgetkey inopencode.jsonwould let users reorder or hide widgets via config.label: string, value?: string— you can't render a multi-line git diff, a markdown table, or freeform text. Supporting freeformcontentwithformat: "text" | "markdown"would cover more use cases.idis a bare string — two plugins could collide on"status".setIntervalis cleaned up viaonCleanup, but there's nodisposehook for plugin-level teardown.setIntervaldoesn't check if the previous fetch completed. Slow responses could stack up.Goldppx commentedon Apr 3, 2026
How's it going now
code-lixm commentedon Apr 9, 2026
How's it going now
yulinyuzhu commentedon Apr 27, 2026
Looking forward to any updates
eggyShrimp commentedon May 19, 2026
How's it going now
th3wingman commentedon Jun 11, 2026
is this still going in?
spde commentedon Jun 26, 2026
Strong +1. We run a set of org-standard opencode plugins, one of which computes a per-session "operational entropy" signal (a session-shape/health score) and surfaces it in the TUI sidebar. For developers on the desktop/web clients that signal silently disappears — there's no renderer extension point, so a whole class of plugin-provided status UX is TUI-only today.
Two things that would make this land well:
SidebarPanelpayload keeps arbitrary plugin JS out of the renderer, which matters for the web/PWA security model.Happy to test against a real third-party plugin if a design lands.
panhaoyu commentedon Aug 16, 2026
Looking forward to the update of this feature.
docs(01.2): opencode sidebar/status-bar viability research
neriousy commentedon Oct 1, 2026
TUI plugins in OpenCode v2 can add their own sidebar sections through the
sidebar.contentandsidebar.footerslots (context.ui.slot(...)). The built-in Context and MCP panels use the same API.Added in 44cd984 and expanded in #41189.
Closing as completed. If something doesn't work on v2, please open a new issue.