opencode-traffic-light 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 niushuai1991
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,79 @@
+# OpenCode Traffic Light
+
+A TUI plugin that adds a status indicator to your terminal title bar, giving you a quick visual cue of what OpenCode is doing.
+
+## Status Colors
+
+| Color | Meaning |
+|-------|---------|
+| 🟢 Green | Idle, waiting for input, or pending permission/question |
+| 🟡 Yellow | Busy but no active tool or text output (thinking) |
+| 🔴 Red | Running tools or generating text |
+
+## Installation
+
+### Option 1: Install from npm (recommended)
+
+Install the package:
+
+```bash
+npm install opencode-traffic-light
+```
+
+Then add to your project's `.opencode/tui.json`:
+
+```jsonc
+{
+  "plugin": ["opencode-traffic-light"]
+}
+```
+
+Or install globally via `~/.config/opencode/tui.json`.
+
+### Option 2: Install from GitHub
+
+Add to your project's `.opencode/tui.json`:
+
+```jsonc
+{
+  "plugin": ["opencode-traffic-light@git+https://github.com/niushuai1991/opencode-traffic-light.git"]
+}
+```
+
+Or install globally via `~/.config/opencode/tui.json`.
+
+### Option 3: Local plugin file
+
+Copy `src/index.ts` into your project's plugin directory:
+
+```
+.opencode/plugins/traffic-light.ts
+```
+
+### Option 4: Global plugin file
+
+Copy `src/index.ts` to the global plugin directory:
+
+```
+~/.config/opencode/plugins/traffic-light.ts
+```
+
+## Usage
+
+The traffic light activates automatically. The terminal title will look like:
+
+- `🟢 OC | My Session` — idle
+- `🟡 OC | My Session` — thinking
+- `🔴 OC | My Session` — working
+
+### Toggle
+
+Run **"Toggle traffic light"** from the command palette to enable or disable the traffic light. The preference is persisted across sessions.
+
+### Environment Variable
+
+Set `OPENCODE_DISABLE_TERMINAL_TITLE=1` to prevent the plugin from modifying the terminal title.
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "opencode-traffic-light",
+  "version": "1.0.0",
+  "description": "TUI plugin that adds a traffic-light status indicator to your OpenCode terminal title",
+  "type": "module",
+  "license": "MIT",
+  "author": "niushuai1991",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/niushuai1991/opencode-traffic-light.git"
+  },
+  "homepage": "https://github.com/niushuai1991/opencode-traffic-light#readme",
+  "bugs": {
+    "url": "https://github.com/niushuai1991/opencode-traffic-light/issues"
+  },
+  "keywords": ["opencode", "opencode-plugin", "tui", "terminal", "status", "traffic-light"],
+  "files": ["src", "README.md", "LICENSE"],
+  "exports": {
+    "./tui": "./src/index.ts"
+  },
+  "peerDependencies": {
+    "@opencode-ai/plugin": ">=1.0.0"
+  },
+  "engines": {
+    "opencode": ">=1.0.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,148 @@
+import type { TuiPlugin, TuiPluginModule } from "@opencode-ai/plugin/tui"
+
+type TrafficLightColor = "green" | "yellow" | "red"
+
+type TrafficLightInput = {
+  enabled: boolean
+  sessionStatus?: { type: string }
+  messages?: readonly { role: string; id: string }[]
+  pendingInput: boolean
+  parts?: readonly {
+    type: string
+    state?: { status?: string }
+    synthetic?: boolean
+    ignored?: boolean
+  }[]
+}
+
+function computeTrafficLight(input: TrafficLightInput): TrafficLightColor | null {
+  if (!input.enabled) return null
+  if (!input.sessionStatus || input.sessionStatus.type === "idle") return "green"
+  if (!input.messages || input.messages.length === 0) return "green"
+  if (input.pendingInput) return "green"
+
+  const lastAssistant = [...input.messages].reverse().find(m => m.role === "assistant")
+  if (!lastAssistant) return "yellow"
+  if (!input.parts || input.parts.length === 0) return "yellow"
+
+  const hasActiveTool = input.parts.some(
+    p => p.type === "tool" && (p.state?.status === "running" || p.state?.status === "pending"),
+  )
+  if (hasActiveTool) return "red"
+
+  const hasActiveText = input.parts.some(
+    p => p.type === "text" && !p.synthetic && !p.ignored,
+  )
+  if (hasActiveText) return "red"
+
+  return "yellow"
+}
+
+function statusEmoji(color: TrafficLightColor | null): string {
+  if (color === "green") return "\u{1F7E2}"
+  if (color === "yellow") return "\u{1F7E1}"
+  if (color === "red") return "\u{1F534}"
+  return ""
+}
+
+const EVENTS = [
+  "session.status",
+  "session.idle",
+  "message.updated",
+  "message.part.updated",
+  "message.part.delta",
+  "permission.asked",
+  "permission.replied",
+  "question.asked",
+  "question.replied",
+  "session.next.tool.called",
+  "session.next.tool.success",
+  "session.next.tool.failed",
+  "session.next.text.started",
+  "session.next.text.ended",
+] as const
+
+const tui: TuiPlugin = async (api) => {
+  if (process.env.OPENCODE_DISABLE_TERMINAL_TITLE === "1") return
+
+  const KV_KEY = "traffic_light_enabled"
+  let enabled = api.kv.get<boolean>(KV_KEY, true)
+  let timer: ReturnType<typeof setTimeout> | undefined
+
+  function scheduleUpdate() {
+    if (timer !== undefined) clearTimeout(timer)
+    timer = setTimeout(doUpdateTitle, 0)
+  }
+
+  function doUpdateTitle() {
+    timer = undefined
+    const route = api.route.current
+    if (route.name !== "session") {
+      api.renderer.setTerminalTitle("OpenCode")
+      return
+    }
+
+    const sessionID = route.params.sessionID
+    const status = api.state.session.status(sessionID)
+    const messages = api.state.session.messages(sessionID)
+    const permissions = api.state.session.permission(sessionID)
+    const questions = api.state.session.question(sessionID)
+    const lastAssistant = messages && [...messages].reverse().find(m => m.role === "assistant")
+    const parts = lastAssistant ? api.state.part(lastAssistant.id) : undefined
+
+    const color = computeTrafficLight({
+      enabled,
+      sessionStatus: status ?? undefined,
+      messages,
+      pendingInput: permissions.length > 0 || questions.length > 0,
+      parts,
+    })
+    const emoji = statusEmoji(color)
+
+    const session = api.state.session.get(sessionID)
+    const isDefaultTitle = !session?.title || session.title.trim() === ""
+    if (isDefaultTitle) {
+      api.renderer.setTerminalTitle(`${emoji} OpenCode`)
+      return
+    }
+
+    const title =
+      session!.title.length > 40 ? session!.title.slice(0, 37) + "..." : session!.title
+    api.renderer.setTerminalTitle(`${emoji} OC | ${title}`)
+  }
+
+  const unsubscribers = EVENTS.map((event) => api.event.on(event, () => scheduleUpdate()))
+
+  api.keymap.registerLayer({
+    commands: [
+      {
+        name: "traffic_light.toggle",
+        title: "Toggle traffic light",
+        category: "Plugin",
+        namespace: "palette",
+        run() {
+          enabled = !enabled
+          api.kv.set(KV_KEY, enabled)
+          api.ui.toast({
+            variant: "info",
+            message: `Traffic light ${enabled ? "enabled" : "disabled"}`,
+          })
+          scheduleUpdate()
+        },
+      },
+    ],
+    bindings: [],
+  })
+
+  api.lifecycle.onDispose(() => {
+    if (timer !== undefined) clearTimeout(timer)
+    unsubscribers.forEach((fn) => fn())
+  })
+}
+
+const plugin: TuiPluginModule & { id: string } = {
+  id: "opencode-traffic-light",
+  tui,
+}
+
+export default plugin