Skip to content

Commit 8885d74

Browse files
committed
docs: opencode 1.17.10 npm-spec 로드 버그 안내 + file:// 워크어라운드 추가
opencode 1.17.10(OpenTUI 0.4.2 회귀, anomalyco/opencode#33884)에서 npm 패키지 spec으로 로드되는 TUI 플러그인이 조용히 로드 실패하는 문제를 README 상단 경고로 명시하고, git clone + file:// 절대경로 로드 워크어라운드를 추가. 기존 npm 설치 사용자가 AI 에이전트에 붙여넣어 자동 전환할 수 있는 프롬프트도 포함.
1 parent 7eb6c1c commit 8885d74

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,42 @@ Click either header (`▼`/`▶`) to collapse that section independently.
2929

3030
## Install
3131

32+
> [!WARNING]
33+
> **opencode 1.17.10 breaks TUI plugins installed by npm package spec** ([anomalyco/opencode#33884](https://github.com/anomalyco/opencode/issues/33884)): the sidebar silently never renders. It is an opencode-side regression (OpenTUI 0.3.4 → 0.4.2) that affects *every* npm-spec TUI plugin — not just this one — and is slated to be fixed in a future opencode release. **Until then, use the `file://` workaround below.** The plain npm install further down works again once that fix ships.
34+
35+
### Workaround: `file://` install (opencode 1.17.10)
36+
37+
A `file://` path lives outside `node_modules`, so opencode runs its Solid JSX transform on it and binds it to the host renderer — exactly why it loads when the npm spec does not. Clone the repo and point opencode at the local source:
38+
39+
```bash
40+
git clone https://github.com/coin-seeker/opencode-usage.git ~/.opencode-plugins/opencode-usage
41+
cd ~/.opencode-plugins/opencode-usage && npm install
42+
```
43+
44+
Then set **`~/.config/opencode/tui.json`** to the absolute local path (replace any `opencode-usage-sidebar` entry, and use *your* real home directory):
45+
46+
```json
47+
{
48+
"$schema": "https://opencode.ai/tui.json",
49+
"plugin": [
50+
["file:///Users/YOU/.opencode-plugins/opencode-usage/src/tui.tsx", { "enabled": true }]
51+
]
52+
}
53+
```
54+
55+
Restart opencode. Update later with `git -C ~/.opencode-plugins/opencode-usage pull`. Options work the same way — pass them as the second element of the entry (see [Options](#options)).
56+
57+
#### Let an AI agent switch it for you
58+
59+
Already installed via the npm spec? Paste this to your opencode / Claude agent and it will do the switch:
60+
61+
> opencode 1.17.10 has bug #33884 that silently breaks npm-spec TUI plugins. Set up `opencode-usage-sidebar` as a local `file://` plugin instead:
62+
> 1. Clone & install: `git clone https://github.com/coin-seeker/opencode-usage.git ~/.opencode-plugins/opencode-usage && cd ~/.opencode-plugins/opencode-usage && npm install`
63+
> 2. Edit `~/.config/opencode/tui.json`: remove any plugin entry whose name starts with `opencode-usage-sidebar`, and add `["file://<ABS_PATH>/src/tui.tsx", { "enabled": true }]`, where `<ABS_PATH>` is the clone's real absolute path (expand `~` to my home directory). Keep my other plugins and any options I already had.
64+
> 3. Then tell me to restart opencode and confirm the **Claude Usage** / **Codex Usage** panels appear.
65+
66+
---
67+
3268
Paste below into your OpenCode.
3369

3470
```

0 commit comments

Comments
 (0)