anomalyco/opencode
1
0
Fork 0
mirror of https://github.com/anomalyco/opencode.git synced 2026-07-23 02:36:57 -04:00
Code Issues 5.9k Packages Projects Releases 19 Wiki Activity

Plugin API for custom sidebar panels #3759

New Issue
Open
opened 2026-02-16 17:41:22 -05:00 by yindo · 4 comments
yindo commented 2026-02-16 17:41:22 -05:00
Owner
Copy Link
Copy Source

Originally created by @z80dev on GitHub (Dec 22, 2025).

Originally assigned to: @thdxr on GitHub.

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/sidebar returns 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
Originally created by @z80dev on GitHub (Dec 22, 2025). Originally assigned to: @thdxr on GitHub. ## 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](https://github.com/anthropics/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 ```typescript // 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 ```typescript 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: ```typescript 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/sidebar` returns 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
yindo commented 2026-02-16 17:41:22 -05:00
Author
Owner
Copy Link
Copy Source

@z80dev commented on GitHub (Dec 29, 2025):

First-pass implementation available in #6389

@z80dev commented on GitHub (Dec 29, 2025): First-pass implementation available in #6389
yindo commented 2026-02-16 17:41:22 -05:00
Author
Owner
Copy Link
Copy Source

@fatihdogmus commented on GitHub (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.

@fatihdogmus commented on GitHub (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.
yindo commented 2026-02-16 17:41:22 -05:00
Author
Owner
Copy Link
Copy Source

@mathisdev7 commented on GitHub (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

@mathisdev7 commented on GitHub (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
yindo commented 2026-02-16 17:41:22 -05:00
Author
Owner
Copy Link
Copy Source

@art-shen commented on GitHub (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:
https://github.com/NoeFabris/opencode-antigravity-auth/issues/152

@art-shen commented on GitHub (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: https://github.com/NoeFabris/opencode-antigravity-auth/issues/152
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
acp
bad
bug
discussion
docs
documentation
enhancement
extension
good first issue
growth
help-wanted
mcp
model-problem
needs:compliance
nix
opentui
perf
pull-request
Mirrored from GitHub Pull Request
 tui
web
windows
zen
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: anomalyco/opencode#3759
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?