@jack-yang/opencode-bark-notify 1.0.0

package/README.md

@@ -0,0 +1,105 @@
+# opencode-bark-notify
+
+Focus-aware [Bark](https://github.com/Finb/Bark) push notifications for [OpenCode](https://opencode.ai).
+
+Get **detailed agent messages** on your iPhone when you step away from your computer. When you're at the terminal, notifications are suppressed — no spam.
+
+## Features
+
+- **Focus-aware** — Suppresses notifications when your terminal is the frontmost app
+- **Detailed content** — Sends the agent's actual last message, not just "task completed"
+- **Category badges** — iOS subtitle shows what happened: ✅ Responded / 🔐 Wait for Permission / ❓ Input Needed
+- **Session-aware** — Includes the session title in every notification
+- **Zero dependencies** — Pure TypeScript, runs on Bun
+
+## Prerequisites
+
+- [Bark](https://apps.apple.com/app/id1403753865) app installed on iOS
+- Your Bark device key (found in the Bark app homepage, e.g. `BrHXXCACzphzrB63kNJMFF`)
+
+## Install
+
+### Option 1: With config (recommended)
+
+Add to your `~/.config/opencode/opencode.json`:
+
+```json
+{
+  "plugin": [
+    ["@jack-yang/opencode-bark-notify", {
+      "barkKey": "YOUR_BARK_DEVICE_KEY"
+    }]
+  ]
+}
+```
+
+### Option 2: With env var
+
+Add to your `~/.zshrc`:
+
+```bash
+export BARK_KEY="YOUR_BARK_DEVICE_KEY"
+```
+
+Then in `opencode.json`:
+
+```json
+{
+  "plugin": ["@jack-yang/opencode-bark-notify"]
+}
+```
+
+Restart OpenCode.
+
+## Configuration
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `barkKey` | string | *(env: `BARK_KEY`)* | Bark device key (**required**) |
+| `barkUrl` | string | `https://api.day.app` | Bark server URL (for self-hosted) |
+| `level` | string | `timeSensitive` | iOS notification level |
+| `group` | string | `opencode` | iOS notification group |
+| `terminals` | string[] | `["Ghostty", "Terminal", "iTerm2", ...]` | Terminal app names for focus detection |
+
+### Example with all options
+
+```json
+{
+  "plugin": [
+    ["@jack-yang/opencode-bark-notify", {
+      "barkKey": "YOUR_KEY",
+      "barkUrl": "https://your-bark-server.com",
+      "level": "active",
+      "group": "my-agent",
+      "terminals": ["Ghostty", "WezTerm"]
+    }]
+  ]
+}
+```
+
+## How focus detection works
+
+On macOS, the plugin uses `osascript` to check if a terminal app is the frontmost application. If it is, notifications are suppressed — you're already looking at the terminal. If you've switched to another app or stepped away, notifications fire.
+
+On non-macOS, focus detection is disabled (notifications always fire).
+
+## Notification types
+
+| Event | Badge | Body |
+|-------|-------|------|
+| Session complete | **✅ Responded** | Agent's last message (up to 500 chars) |
+| Permission request | **🔐 Wait for Permission** | Permission type + patterns |
+| Question | **❓ Input Needed** | The question text |
+
+## Pairing with desktop notifications
+
+This plugin complements [@mohak34/opencode-notifier](https://github.com/mohak34/opencode-notifier) (desktop notifications). Use both together:
+
+- **Desktop** (osascript/sound/bell) → when at computer but in another app
+- **Bark** (iPhone push) → when away from computer entirely
+
+Both independently check focus, so there's no conflict.
+
+## License
+
+MIT

package/README.zh-CN.md

@@ -0,0 +1,83 @@
+# opencode-bark-notify
+
+为 [OpenCode](https://opencode.ai) 提供基于 [Bark](https://github.com/Finb/Bark) 的手机推送通知，**智能感知终端焦点**。
+
+离开电脑时收到 **agent 的实际消息内容**，在终端前时自动静默——不打扰。
+
+## 功能
+
+- **焦点感知** — 终端在前台时不发通知，切走或离开时才推
+- **详细内容** — 推送 agent 的最后一条消息，不只是"任务完成"
+- **分类标识** — iOS 副标题显示事件类型：✅ Responded / 🔐 Wait for Permission / ❓ Input Needed
+- **Session 感知** — 每条通知包含 session 标题
+- **零依赖** — 纯 TypeScript，Bun 直接运行
+
+## 前置条件
+
+- iOS 设备安装 [Bark](https://apps.apple.com/app/id1403753865)
+- Bark device key（在 Bark App 首页查看，如 `BrHXXCACzphzrB63kNJMFF`）
+
+## 安装
+
+### 方式一：带配置（推荐）
+
+在 `~/.config/opencode/opencode.json` 中添加：
+
+```json
+{
+  "plugin": [
+    ["@jack-yang/opencode-bark-notify", {
+      "barkKey": "你的BARK设备KEY"
+    }]
+  ]
+}
+```
+
+### 方式二：环境变量
+
+在 `~/.zshrc` 中设置：
+
+```bash
+export BARK_KEY="你的BARK设备KEY"
+```
+
+然后在 `opencode.json` 中：
+
+```json
+{
+  "plugin": ["@jack-yang/opencode-bark-notify"]
+}
+```
+
+重启 OpenCode 生效。
+
+## 配置项
+
+| 选项 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| `barkKey` | string | *(环境变量 `BARK_KEY`)* | Bark 设备 Key（**必填**） |
+| `barkUrl` | string | `https://api.day.app` | Bark 服务器地址（自建服务器用） |
+| `level` | string | `timeSensitive` | iOS 通知级别 |
+| `group` | string | `opencode` | iOS 通知分组 |
+| `terminals` | string[] | `["Ghostty", "Terminal", "iTerm2", ...]` | 焦点检测的终端 App 名称 |
+
+## 通知类型
+
+| 事件 | 标识 | 内容 |
+|------|------|------|
+| Session 完成 | **✅ Responded** | agent 最后一条消息（≤500字） |
+| 需要权限 | **🔐 Wait for Permission** | 权限类型 + 匹配模式 |
+| 需要回答 | **❓ Input Needed** | 问题内容 |
+
+## 与桌面通知配合
+
+本插件与 [@mohak34/opencode-notifier](https://github.com/mohak34/opencode-notifier)（桌面通知）互补：
+
+- **桌面通知**（声音/弹窗）→ 在电脑前但切到了其他窗口
+- **Bark 推送**（手机）→ 完全离开电脑
+
+两者各自独立检测焦点，互不冲突。
+
+## 许可证
+
+MIT

package/index.ts

@@ -0,0 +1,115 @@
+import type { Plugin } from "@opencode-ai/plugin"
+
+interface BarkConfig {
+  barkKey?: string
+  barkUrl?: string
+  level?: string
+  group?: string
+  terminals?: string[]
+}
+
+const DEFAULT_TERMINALS = ["Ghostty", "Terminal", "iTerm2", "Alacritty", "kitty", "WezTerm"]
+const DEFAULT_BARK_URL = "https://api.day.app"
+const MAX_BODY_LENGTH = 500
+
+const isFocused = async (terminals: string[]): Promise<boolean> => {
+  if (process.platform !== "darwin") return false
+  try {
+    const proc = Bun.spawn(
+      ["osascript", "-e", 'tell application "System Events" to name of first application whose frontmost is true'],
+      { stdout: "pipe", stderr: "pipe" },
+    )
+    const output = await new Response(proc.stdout).text()
+    return terminals.includes(output.trim())
+  } catch {
+    return false
+  }
+}
+
+const sendBark = async (
+  barkUrl: string,
+  barkKey: string,
+  title: string,
+  subtitle: string,
+  body: string,
+  level: string,
+  group: string,
+) => {
+  try {
+    await fetch(`${barkUrl}/${barkKey}`, {
+      method: "POST",
+      headers: { "Content-Type": "application/json; charset=utf-8" },
+      body: JSON.stringify({ title, subtitle, body, group, level }),
+    })
+  } catch {}
+}
+
+const truncate = (text: string, max: number): string => {
+  const clean = text.replace(/\n+/g, " ").trim()
+  return clean.length > max ? clean.slice(0, max) + "..." : clean
+}
+
+export const BarkNotifyPlugin: Plugin = async ({ project, client }, config: BarkConfig = {}) => {
+  const barkKey = config.barkKey || process.env.BARK_KEY
+  if (!barkKey) {
+    console.warn(
+      "[opencode-bark-notify] No barkKey configured. Set barkKey in plugin config or BARK_KEY env var.",
+    )
+    return {}
+  }
+
+  const barkUrl = config.barkUrl || process.env.BARK_URL || DEFAULT_BARK_URL
+  const level = config.level || "timeSensitive"
+  const group = config.group || "opencode"
+  const terminals = config.terminals || DEFAULT_TERMINALS
+
+  let lastMessage = ""
+  let currentTitle = `OpenCode · ${project?.id || "Session"}`
+
+  const send = (subtitle: string, body: string) =>
+    sendBark(barkUrl, barkKey, currentTitle, subtitle, body, level, group)
+
+  return {
+    event: async ({ event }) => {
+      if (event.type === "message.part.updated") {
+        const part = event.properties?.part
+        if (part?.type === "text" && part.text) {
+          lastMessage = part.text
+        }
+        if (part?.type === "tool" && part.tool === "question" && part.state?.status === "running") {
+          if (await isFocused(terminals)) return
+          const questions = part.state?.input?.questions || []
+          const q = questions[0]?.question || "Input needed"
+          await send("❓ Input Needed", q)
+        }
+      }
+
+      if (event.type === "session.idle") {
+        if (await isFocused(terminals)) return
+
+        const sid = event.properties?.sessionID
+        if (sid) {
+          try {
+            const sessions = await client.session.list({ limit: 50 })
+            const s = sessions.data?.find((s: any) => s.id === sid)
+            if (s?.title) currentTitle = `OpenCode · ${s.title}`
+          } catch {}
+        }
+
+        const body = lastMessage ? truncate(lastMessage, MAX_BODY_LENGTH) : "Task completed"
+        await send("✅ Responded", body)
+      }
+    },
+
+    "permission.ask": async (input: any) => {
+      if (await isFocused(terminals)) return
+      const permType = input?.type || "permission"
+      const patterns = input?.patterns || []
+      let body = permType
+      if (patterns.length) body += `: ${patterns.join(", ")}`
+      await send("🔐 Wait for Permission", body)
+    },
+  }
+}
+
+export default BarkNotifyPlugin

package/package.json

@@ -0,0 +1,51 @@
+{
+  "$schema": "https://json.schemastore.org/package.json",
+  "name": "@jack-yang/opencode-bark-notify",
+  "version": "1.0.0",
+  "description": "Focus-aware Bark push notifications for OpenCode — get detailed agent messages on your phone when you step away",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./index.ts"
+    }
+  },
+  "engines": {
+    "opencode": ">=1.4.3"
+  },
+  "peerDependencies": {
+    "@opencode-ai/plugin": ">=1.4.3"
+  },
+  "devDependencies": {
+    "vitest": "^3.2.4",
+    "typescript": "^5.9.2"
+  },
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "files": [
+    "index.ts",
+    "README.md"
+  ],
+  "keywords": [
+    "opencode",
+    "opencode-plugin",
+    "bark",
+    "notification",
+    "push-notification",
+    "ios",
+    "focus-aware"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yangwudong/opencode-bark-notify.git"
+  },
+  "homepage": "https://github.com/yangwudong/opencode-bark-notify#readme",
+  "bugs": {
+    "url": "https://github.com/yangwudong/opencode-bark-notify/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}