opencode-tui-stats 0.1.0 → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 aifcoding
+
+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.en.md

@@ -0,0 +1,29 @@
+# opencode-tui-stats
+
+A TUI plugin for OpenCode 1.x (v1) that shows a single line — `TPS | AVG | TTFT` — on the right side of the session prompt.
+
+## Demo
+
+![Demo](./assets/demo.gif)
+
+## Installation
+
+```bash
+opencode plugin opencode-tui-stats --global
+```
+
+This command writes the plugin into opencode's TUI config. You can also install the `opencode-tui-stats` package from npm.
+
+## Requirements
+
+- opencode ≥ 1.3.14
+
+## Metrics
+
+- `TPS`: live generation rate within the most recent ~5-second streaming window (tokens/sec); shows `-` when the session is idle or data is stale.
+- `AVG`: average generation rate of completed messages in this session (tokens/sec).
+- `TTFT`: average time to first token of completed messages in this session (seconds).
+
+## License
+
+MIT — see [LICENSE](./LICENSE) in the repository root.

package/README.md

@@ -1,6 +1,10 @@
 # opencode-tui-stats
 
-OpenCode v1 TUI 插件：在会话提示区右侧显示 `TPS | AVG | TTFT`，即实时流式输出速度（TPS）、本次会话平均生成速度（AVG）以及平均首字延迟（TTFT）。
+OpenCode 1.x（v1）的 TUI 插件，在会话提示区右侧显示一行 `TPS | AVG | TTFT`。
+
+## 演示
+
+![Demo](./assets/demo.gif)
 
 ## 安装
 
@@ -8,10 +12,18 @@ OpenCode v1 TUI 插件：在会话提示区右侧显示 `TPS | AVG | TTFT`，即
 opencode plugin opencode-tui-stats --global
 ```
 
-要求宿主 opencode ≥ 1.3.14。
+该命令会把插件写入 opencode 的 tui 配置。也可以从 npm 安装 `opencode-tui-stats` 包。
+
+## 环境要求
+
+- opencode ≥ 1.3.14
+
+## 指标说明
+
+- `TPS`：最近约 5 秒流式窗口内的实时生成速度（token/秒）；会话空闲或数据过期时显示 `-`。
+- `AVG`：本会话已完成消息的平均生成速度（token/秒）。
+- `TTFT`：本会话已完成消息的平均首字延迟（秒）。
 
-## 显示项
+## License
 
-- `TPS`：最近 5 秒流式窗口内的实时 token/秒，空闲或数据过期时显示 `-`。
-- `AVG`：本次会话已完成消息的平均 token/秒。
-- `TTFT`：本次会话已完成消息的平均首字延迟（秒）。
+MIT，详见仓库根目录的 [LICENSE](./LICENSE)。

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "opencode-tui-stats",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "OpenCode 1 TUI plugin that shows live TPS, average TPS, and average time to first token in the session prompt.",
   "type": "module",
   "exports": {
@@ -33,6 +33,7 @@
   },
   "files": [
     "tui.tsx",
-    "README.md"
+    "README.md",
+    "assets/"
   ]
 }