opencode-ollama-ps 0.0.0-stage → 0.1.1

package/README.md

@@ -1,3 +1,114 @@
-# Temporary Holding Version
+# opencode-ollama-ps
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+OpenCode TUI sidebar plugin that displays Ollama running models (model **name**, **size**, **processor**, and **until**) in the right sidebar alongside the built-in context length and todo list.
+
+```
+ Context       12,345 tokens   45% used
+ Ollama
+ devstral-small-2:latest   55.0 GB   llamacpp   4 minutes
+ Todo
+ □ Review pull request
+ □ Fix login bug
+```
+
+## Install (OpenCode v2.2.6+)
+
+For file-based TUI plugins, OpenCode only needs the single `.tsx` file — do **not** copy `package.json` into the plugins directory (it triggers a failed `npm install`).
+
+1. Copy just the plugin file:
+
+```sh
+mkdir -p ~/.config/opencode/plugins/opencode-ollama-ps/src
+cp /path/to/opencode-ollama-ps/src/index.tsx ~/.config/opencode/plugins/opencode-ollama-ps/src/index.tsx
+```
+
+2. Register it in `~/.config/opencode/tui.json` (use `file://` prefix if the plain path doesn't load):
+
+```json
+{
+  "$schema": "https://opencode.ai/tui.json",
+  "plugin": [
+    "file:///home/eike/.config/opencode/plugins/opencode-ollama-ps/src/index.tsx"
+  ]
+}
+```
+
+If `file://` doesn't work, try the plain absolute path:
+```json
+{
+  "plugin": [
+    "/home/eike/.config/opencode/plugins/opencode-ollama-ps/src/index.tsx"
+  ]
+}
+```
+
+3. **Do not** add it to `cli.json` — that would try to load it as a server plugin and fail.
+
+4. Clear OpenCode's cache and restart:
+
+```sh
+rm -rf ~/.cache/opencode/
+export OLLAMA_HOST=http://172.23.192.1:11434
+opencode
+```
+
+## Configuration (optional)
+
+Add options under the plugin entry in `tui.json`:
+
+```json
+{
+  "plugin": [
+    ["file:///home/eike/.config/opencode/plugins/opencode-ollama-ps/src/index.tsx", {
+      "ollamaIntervalMs": 5000
+    }]
+  ]
+}
+```
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `ollamaIntervalMs` | `5000` | How often to poll the Ollama API (ms) |
+
+## How it works
+
+- Registers a `sidebar_content` slot contribution, so the panel appears in the right sidebar next to Context, MCP, LSP, and Todos.
+- Polls the Ollama HTTP API (`GET {host}/api/ps`) via `fetch` on a timer — no `ollama` CLI binary needed.
+- Reads **`$OLLAMA_HOST`** from the environment (default `http://localhost:11434`), so remote Ollama hosts work out of the box.
+- Renders each loaded model's name, size, processor, and time-until-unload.
+- Shows an error line in the sidebar if the API call fails, and a "no models loaded" line when nothing is running.
+
+## Important: where the panel appears
+
+- **TUI plugins do not show in `opencode plugin list`** — that command only lists server plugins.
+- The sidebar panel only renders when you're in an **active session** (not on the home screen). Start a chat session and look at the right sidebar.
+- If you don't see a sidebar, press `Ctrl+X B` (or `leader b`) to toggle it.
+
+## Troubleshooting
+
+Panel not showing at all:
+1. Make sure you're in an active chat session (sidebar panels only render during sessions)
+2. Export `OLLAMA_HOST` before launching OpenCode:
+   ```sh
+   export OLLAMA_HOST=http://172.23.192.1:11434
+   opencode
+   ```
+3. Completely quit OpenCode, clear cache, and restart:
+   ```sh
+   rm -rf ~/.cache/opencode/
+   ```
+4. Try the `file://` prefix in `tui.json` (see Install above)
+5. Verify the Ollama API is reachable: `curl http://172.23.192.1:11434/api/ps`
+
+Panel shows `error: ... connection refused` / `host: http://...`:
+- OpenCode can't reach the Ollama host. The host should be the base URL without `/v1` (your Ollama API base is `http://172.23.192.1:11434/v1`, so `OLLAMA_HOST=http://172.23.192.1:11434`).
+
+Panel stays empty / `no models loaded`:
+- No Ollama models are currently loaded. Load a model first, then the panel appears.
+
+Server plugin error / NpmInstallFailedError:
+- You likely added the plugin to `cli.json` (server plugins) or copied `package.json` into the plugins directory. Remove it from `cli.json` and install only `src/index.tsx` (see Install above).
+
+## Uninstall
+
+Remove the plugin entry from `tui.json` and restart OpenCode.

package/package.json

@@ -1,6 +1,34 @@
 {
   "name": "opencode-ollama-ps",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "OpenCode TUI sidebar plugin that shows ollama ps output (size, processor, context) alongside context length and todos.",
+  "type": "module",
+  "main": "src/index.tsx",
+  "exports": {
+    ".": "./src/index.tsx",
+    "./tui": "./src/index.tsx"
+  },
+  "tui": {
+    "plugin": "./src/index.tsx"
+  },
+  "dependencies": {
+    "@opencode-ai/plugin": "^1.4.0",
+    "@opentui/core": "^0.1.97",
+    "@opentui/solid": "^0.1.97",
+    "solid-js": "^1.9.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0",
+    "typescript": "^5.0.0"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit"
+  },
+  "files": [
+    "src",
+    "tui.ts"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/index.tsx

@@ -0,0 +1,137 @@
+/** @jsxImportSource ./jsx-runtime */
+import type { TuiPlugin, TuiPluginApi, TuiPluginModule } from "@opencode-ai/plugin/tui"
+import { createMemo, createSignal, Show, For } from "solid-js"
+
+type OllamaModel = {
+  name: string
+  id: string
+  size: string
+  processor: string
+  until?: string
+}
+
+const DEFAULT_INTERVAL_MS = 5000
+const DEFAULT_OLLAMA_HOST = "http://localhost:11434"
+
+function resolveHost(options: Record<string, unknown> | undefined): string {
+  return (
+    (process.env.OLLAMA_HOST as string | undefined) ??
+    DEFAULT_OLLAMA_HOST
+  )
+}
+
+function fmtBytes(bytes: number): string {
+  if (!bytes) return "—"
+  const units = ["B", "KB", "MB", "GB", "TB"]
+  let v = bytes
+  let u = 0
+  while (v >= 1024 && u < units.length - 1) {
+    v /= 1024
+    u++
+  }
+  return `${v.toFixed(1)} ${units[u]}`
+}
+
+function rgbaToHex(rgba: { r: number; g: number; b: number; a: number }): string {
+  const toHex = (n: number) => Math.round(n * 255).toString(16).padStart(2, "0")
+  return `#${toHex(rgba.r)}${toHex(rgba.g)}${toHex(rgba.b)}`
+}
+
+async function fetchOllamaPs(host: string): Promise<{ models: OllamaModel[]; error?: string }> {
+  try {
+    const res = await fetch(`${host}/api/ps`, { signal: AbortSignal.timeout(10000) })
+    if (!res.ok) {
+      return { models: [], error: `HTTP ${res.status}` }
+    }
+    const data = (await res.json()) as { models?: unknown[] }
+    const models: OllamaModel[] = (data.models ?? []).map((m: any) => ({
+      name: m.name ?? m.model ?? "unknown",
+      id: m.id ?? "",
+      size: m.size_label ?? fmtBytes(m.size ?? 0),
+      processor: m.processor ?? "?",
+      until: m.expires_at_label ?? m.expires_at,
+    }))
+    return { models, error: undefined }
+  } catch (err) {
+    return {
+      models: [],
+      error: err instanceof Error ? err.message : String(err),
+    }
+  }
+}
+
+const tui: TuiPlugin = async (api, options, meta) => {
+  const intervalMs =
+    (options?.ollamaIntervalMs as number | undefined) ?? DEFAULT_INTERVAL_MS
+  const host = resolveHost(options)
+
+  const [version, setVersion] = createSignal(0)
+  const [state, setState] = createSignal<{
+    models: OllamaModel[]
+    error?: string
+  }>({ models: [], error: undefined })
+
+  const refresh = () => {
+    void fetchOllamaPs(host).then((result) => {
+      setState({ models: result.models, error: result.error })
+      setVersion((v) => v + 1)
+    })
+  }
+
+  const intervalId = setInterval(refresh, intervalMs)
+  refresh()
+
+  api.lifecycle.onDispose(() => {
+    clearInterval(intervalId)
+  })
+
+  const data = createMemo(() => {
+    version()
+    return state()
+  })
+
+  api.slots.register({
+    order: 450,
+    slots: {
+      sidebar_content(_ctx, props) {
+        const d = data()
+        const theme = api.theme.current
+        const rows = d.models
+
+        return (
+          <>
+            <text fg={rgbaToHex(theme.text)}>
+              <b>Ollama</b>
+            </text>
+            <Show when={d.error}>
+              <text fg={rgbaToHex(theme.textMuted)}>
+                error: {d.error} (host: {host})
+              </text>
+            </Show>
+            <Show when={!d.error && rows.length === 0}>
+              <text fg={rgbaToHex(theme.textMuted)}>no models loaded</text>
+            </Show>
+            <For each={rows}>
+              {(m) => (
+                <>
+                  <text fg={rgbaToHex(theme.textMuted)}>{m.name}</text>
+                  <text fg={rgbaToHex(theme.textMuted)}>{m.size}</text>
+                  <text fg={rgbaToHex(theme.textMuted)}>{m.processor}</text>
+                  <Show when={m.until}>
+                    <text fg={rgbaToHex(theme.textMuted)}>{m.until}</text>
+                  </Show>
+                </>
+              )}
+            </For>
+          </>
+        )
+      },
+    },
+  })
+}
+
+const plugin: TuiPluginModule & { id: string } = {
+  id: "opencode.ollama-ps",
+  tui,
+}
+export default plugin

package/src/jsx-dev-runtime.ts

@@ -0,0 +1,24 @@
+// JSX runtime for @opentui/solid compatibility
+import { createElement, spread, createComponent } from "@opentui/solid"
+
+function Fragment(props: { children?: unknown }): unknown {
+  const children = props.children
+  return typeof children === "function" ? children() : children
+}
+
+function jsx(type: any, props: any = {}, ...children: any[]): any {
+  if (typeof type === "string") {
+    const el = createElement(type)
+    if (props) {
+      const merged = { ...props }
+      if (children.length > 0) {
+        merged.children = children.length === 1 ? children[0] : children
+      }
+      spread(el, merged)
+    }
+    return el
+  }
+  return createComponent(type, { ...props, children: children.length === 1 ? children[0] : children })
+}
+
+export { jsx, jsx as jsxs, jsx as jsxDEV, Fragment }

package/src/jsx-runtime/index.ts

@@ -0,0 +1,24 @@
+// JSX runtime entry for @opentui/solid compatibility
+import { createElement, spread, createComponent } from "@opentui/solid"
+
+function Fragment(props: { children?: unknown }): unknown {
+  const children = props.children
+  return typeof children === "function" ? children() : children
+}
+
+function jsx(type: any, props: any = {}, ...children: any[]): any {
+  if (typeof type === "string") {
+    const el = createElement(type)
+    if (props) {
+      const merged = { ...props }
+      if (children.length > 0) {
+        merged.children = children.length === 1 ? children[0] : children
+      }
+      spread(el, merged)
+    }
+    return el
+  }
+  return createComponent(type, { ...props, children: children.length === 1 ? children[0] : children })
+}
+
+export { jsx, jsx as jsxs, Fragment }

package/src/jsx-runtime/jsx-dev-runtime.ts

@@ -0,0 +1,24 @@
+// JSX dev runtime for @opentui/solid compatibility
+import { createElement, spread, createComponent } from "@opentui/solid"
+
+function Fragment(props: { children?: unknown }): unknown {
+  const children = props.children
+  return typeof children === "function" ? children() : children
+}
+
+function jsxDEV(type: any, props: any = {}, ...children: any[]): any {
+  if (typeof type === "string") {
+    const el = createElement(type)
+    if (props) {
+      const merged = { ...props }
+      if (children.length > 0) {
+        merged.children = children.length === 1 ? children[0] : children
+      }
+      spread(el, merged)
+    }
+    return el
+  }
+  return createComponent(type, { ...props, children: children.length === 1 ? children[0] : children })
+}
+
+export { jsxDEV, Fragment }

package/src/jsx-runtime.ts

@@ -0,0 +1,25 @@
+// JSX runtime for @opentui/solid compatibility
+// Re-exports createElement, spread, createComponent with a local Fragment
+import { createElement, spread, createComponent } from "@opentui/solid"
+
+function Fragment(props: { children?: unknown }): unknown {
+  const children = props.children
+  return typeof children === "function" ? children() : children
+}
+
+function jsx(type: any, props: any = {}, ...children: any[]): any {
+  if (typeof type === "string") {
+    const el = createElement(type)
+    if (props) {
+      const merged = { ...props }
+      if (children.length > 0) {
+        merged.children = children.length === 1 ? children[0] : children
+      }
+      spread(el, merged)
+    }
+    return el
+  }
+  return createComponent(type, { ...props, children: children.length === 1 ? children[0] : children })
+}
+
+export { jsx, jsx as jsxs, jsx as jsxDEV, Fragment }

package/tui.ts

@@ -0,0 +1 @@
+export { default } from "./src/index.tsx"