Codex Token Meter
by Asce66
README.md
# Codex Token Meter · Windows 测试版
在 Codex 桌面端的会话面板中查看本地对话的**生成片段平均 Token/s**、输出 Token、思考 Token 和最近的速度走势。
这是独立社区项目,不隶属于 OpenAI。当前版本为 **0.2.0-beta.1**,面向 GitHub / 自定义插件市场测试分发,不代表已上架官方插件目录。
## 功能与边界
- 使用 Codex 插件面板,不修改客户端安装文件,不创建独立浮窗,不添加 Windows 登录自启动。
- 在可见的 Codex 聊天之间自动跟随;也可在面板中手动选择对话。
- 速度为生成片段结束后的平均估算值,**不是逐 Token 的瞬时流速**。输出计数包含思考与工具调用参数,思考数是输出数的子集。
- 新日志优先使用生成条目的时间窗;工具执行、审批后工具等待和用户等待不作为模型输出时间。旧日志的边界计时可能包含请求准备及首字等待。
- 当前界面是会话面板,**不是输入框下方的原生常驻状态栏**。不提供客户端注入或覆盖层。
- 无可靠样本时显示 `—`;同名聊天无法唯一识别时停止自动匹配,不按后台活跃时间猜测。
## 环境要求
| 项目 | 要求 |
| --- | --- |
| 系统 | 目标为 Windows 10/11 x64;本机验收环境为 Windows 11 x64 |
| Codex | 支持本地 marketplace、stdio MCP 和 MCP Apps 会话面板的桌面版本 |
| Node.js | 22 或更新版本,桌面应用的 `PATH` 中可以找到 `node` |
| Python | 3.10 或更新版本,具备标准库 `sqlite3`;不需要安装 Python 第三方包 |
| 自动识别 | 依赖 Windows UI Automation 和 .NET Framework 4.8 桌面程序集;当前主要适配 MSIX 版 Codex |
安装 Node/Python 后请完全退出并重新打开 Codex,使桌面进程继承新的 `PATH`。
macOS/Linux 的自动识别不在此测试版支持范围内。数据库与日志格式是 Codex 内部实现,升级后可能需要适配。
## 安装已构建版本
仓库里的 `plugins/codex-token-meter/` 是可直接安装的发行产物,已包含 JS 依赖和 Windows 识别助手。普通使用者不需要执行 `npm install` 或编译 C#。
### 从本地目录或源码 ZIP 安装
解压源码 ZIP,进入包含 `.agents/plugins/marketplace.json` 的仓库根目录,在 PowerShell 执行:
```powershell
codex plugin marketplace add .
codex plugin add codex-token-meter@asce-local-tools
codex plugin list --marketplace asce-local-tools --json
```
需要终端能运行 Codex CLI。若找不到 `codex`,请先按 [Codex 官方插件指南](https://developers.openai.com/plugins/build/plugins)完成 CLI / 本地市场配置。
如果已经注册过同名 `asce-local-tools` 市场,请先检查它的来源。不要覆盖仍包含其他插件的市场;旧的个人开发市场与本仓库应择一使用。
### 从 GitHub 安装
从 GitHub 的预发布标签安装:
```powershell
codex plugin marketplace add Asce66/codex-token-meter --ref v0.2.0-beta.1
codex plugin add codex-token-meter@asce-local-tools
```
仓库:[Asce66/codex-token-meter](https://github.com/Asce66/codex-token-meter)。
下载包与校验文件见 [Releases](https://github.com/Asce66/codex-token-meter/releases),建议固定版本标签以便复现。
安装后重新打开聊天或重启 Codex,让新工具连接生效。在插件页选择 **Token 测速 → 立即试用**,或在启用该插件的对话里发送:
> 打开当前对话的 Token 测速面板
## 解释器自动发现与诊断
插件在实际读取指标时,先用 Windows 的 `py --list-paths` 枚举已安装解释器,再尝试 `PATH` 中的 `python3` / `python`,验证版本和 SQLite 后使用真实解释器。会跳过 Microsoft Store 的占位别名,并禁止 Python 管理器自动安装;没有预置任何人的路径,不会自动下载安装依赖。
在源码目录运行诊断:
```powershell
node scripts/doctor.mjs
node scripts/doctor.mjs --json
```
`--verbose` 可显示本机路径供自己排查;公开贴诊断结果前请删除用户名和路径。
可选配置:
| 环境变量 | 用途 |
| --- | --- |
| `CODEX_TOKEN_METER_PYTHON` | 指定 Python **可执行文件路径**,不是带参数的命令;显式配置无效时会报错,不偷偷切换解释器 |
| `CODEX_TOKEN_METER_FOLLOW_ACTIVE=0` | 关闭 Windows 窗口识别,改为从面板手动选择对话 |
| `CODEX_HOME` | 使用非默认的 Codex 数据目录;默认是当前用户的 `.codex` |
| `PLUGIN_DATA` | 由插件宿主提供的可写运行目录,普通用户无需设置 |
例如,为当前 PowerShell 中的诊断或 CLI Codex 指定虚拟环境:
```powershell
$env:CODEX_TOKEN_METER_PYTHON = (Resolve-Path .\.venv\Scripts\python.exe).Path
node scripts/doctor.mjs
```
桌面 Codex 不会继承已经运行后才设置的终端变量;需要在用户环境中配置并重启桌面应用。请勿直接编辑 `.codex/plugins/cache/` 中的安装缓存。
## 卸载与数据清理
先关闭测速面板并在插件页停用,然后执行:
```powershell
codex plugin remove codex-token-meter@asce-local-tools
```
只有在没有其他插件依赖该市场时,才移除市场注册:
```powershell
codex plugin marketplace remove asce-local-tools
```
后端进程随 MCP 连接结束而退出,空闲时也会释放指标工作进程。插件不会删除 Codex 对话或训练 / 项目数据。
运行文件缓存位置和手动清理范围见 [PRIVACY.md](PRIVACY.md)。清理前应退出相关进程;不要删除整个 `.codex` 目录。
## 从源码构建与测试
```powershell
npm ci --ignore-scripts --no-audit --no-fund
npm run build
npm test
npm run test:python
npm run package
```
构建脚本从 Windows 系统目录发现 C# 编译器,编译 `native/ActiveChatProbe.cs`,并内联前端脚本 / 样式。不会生成个人解释器路径配置。
`npm run package` 在 `dist/` 生成插件 ZIP、源码 ZIP 和 SHA-256 校验文件,打包前会检查配置与隐私字段。
开发目录:
```text
src/ MCP 服务器、界面、Python 指标后端
native/ Windows 无障碍识别助手源码
scripts/ 构建、诊断、预览、打包
tests/ 合成数据测试,不使用维护者的聊天记录
plugins/ 可安装发行产物,随版本提交
.agents/plugins/ 仓库 marketplace
```
`npm run preview` 可在本机浏览示例界面;预览使用合成数据,不连接模型、不读真实对话。
CI 已配置 Windows 下的 Node/Python 测试组合,实际结果见 [GitHub Actions](https://github.com/Asce66/codex-token-meter/actions)。CI 不等于所有用户机器的兼容性保证。
## 已知限制与问题反馈
- 目前只完成维护者 Windows 机器上的验收,仍需要其他机器的干净安装反馈。
- 自动识别依赖可访问的 Codex 窗口标题与本地索引。完全同名聊天、远程聊天、未适配的客户端版本可能需要手动选择。
- 一次很长的单段生成可能很久才更新速度;不把上一段读数冒充当前流式速率。
- Windows 助手尚未代码签名,可从本仓库源码自行构建。
- 提问题时附版本、Node/Python 版本、匿名诊断和复现步骤。**不要上传 `auth.json`、原始 JSONL 日志、真实聊天正文或带个人信息的截图。**
## 许可与隐私
项目代码采用 [MIT](LICENSE)。打包的第三方依赖保留各自许可证,见 [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md)。
完整数据说明见 [PRIVACY.md](PRIVACY.md)。插件没有自建上传或遥测服务;指标工具的返回值会交给 Codex,可能进入模型上下文。
This server cannot be deployed
Maintenance
ActivityMaintained
ResponsivenessNo recent community issues