dsh-opencode-usage
开发工具 活跃维护

dsh-opencode-usage

zzh799/dsh-opencode-usage

作为OpenCode编辑器的轻量Web GUI插件,可直接在编辑器工具行展示Zen账户余额与Go模型使用额度,无需跳转页面即可实时查看资源消耗状态,操作便捷。

0
Stars 标星
0
Forks 分支
0
Watchers 关注
0
Open Issues
TypeScript
主要语言
MIT
开源协议
328 KB
仓库大小
1 个月前
最后推送
一键安装扩展 / 插件指令
dsh plugin --profile web add github:zzh799/dsh-opencode-usage
git clone https://github.com/zzh799/dsh-opencode-usage.git
git clone git@github.com:zzh799/dsh-opencode-usage.git
README.md main

dsh-opencode-usage

A dsh web GUI plugin that shows your
OpenCode Zen balance and Go usage windows right in the composer tool row: a
concentric-ring button (rolling 5h / weekly / monthly) that opens a usage
panel.

  • Host half (src/index.tslib/index.js): resolves config from env
    vars and $DSH_HOME/ocgo-usage.json, fetches the opencode.ai SSR pages,
    and serves same-origin JSON endpoints with caching + failure cooldown.
  • Browser half (src/client.tsxlib/client.js): renders the
    concentric-ring composer button and usage panel, and the config editor
    (cookie values are only ever shown masked — the full cookie never leaves
    the host).

button
panel

Features

  • Rolling 5-hour / weekly / monthly usage rings on a single composer button
  • Usage panel with window details and a manual refresh
  • Built-in config editor in the panel (masked cookie tails only)
  • Smart cookie normalization: paste the raw auth token, a full header, or
    anything in between
  • Server-side cache (default 5 min) + 60 s failure cooldown so the poller
    never spams opencode.ai
  • Optional peak-clock display (showPeakClock)

Install

# From a local checkout (or a tarball), add into the dsh web profile:
dsh plugin --profile web add /path/to/dsh-opencode-usage

cordis.patch.yml inserts the plugin as opencode-usage; it requires the
webServer service.

Configuration

Priority: env vars > config file ($DSH_HOME/ocgo-usage.json) > defaults.

Env var Config file key Default Description
OPENCODE_GO_COOKIE cookie OpenCode Go session cookie (auto-normalized)
OPENCODE_GO_WORKSPACE_ID workspaceID OpenCode workspace id
OPENCODE_GO_BASE_URL baseUrl https://opencode.ai Provider base URL
OPENCODE_GO_CACHE_TTL cacheTTL 300 Cache TTL in seconds, clamped to [60, 3600]
OPENCODE_GO_TIMEOUT_MS timeoutMs 15000 Fetch timeout in ms
showPeakClock false Show the peak-clock readout

The cookie is never logged. You can also edit cookie / workspaceID /
showPeakClock from the panel's config editor; a successful write invalidates
the cache so the next poll uses the fresh values immediately.

Config file is written with chmod 600.

API

The browser half talks to the host over plain same-origin JSON:

Method Path Description
GET /api/opencode-usage Cached usage view
GET /api/opencode-usage/refresh Force a fresh provider query
GET /api/opencode-usage/config Masked config view
POST /api/opencode-usage/config Write cookie / workspace / showPeakClock

Development

npm install      # dev deps (esbuild) — prepack build runs automatically
npm run build    # emit lib/client.js + lib/index.js
npm run watch    # hot-swap rebuilds into a running `dsh web` host

The build mirrors the dsh plugin loader contract: the browser bundle rides in
the closure-factory module format with react/platform modules externalized,
and CSS is inlined idempotently (data-plugin-css).

License

MIT