xiufengsun/TokenTracker:README 来源编辑指南
基于 README、仓库元数据和许可证整理 xiufengsun/TokenTracker 的安装与核验路径。
项目定位
xiufengsun/TokenTracker 的 README 将项目描述为"Local-first AI token usage & cost tracker for 28 coding tools incl. Claude Code, Codex, Cursor, Gemini & Qoder,with native apps. Never reads prompts."。本文只整理仓库能直接核验的内容,不把星标、Fork 或宣传语当成质量证明。README 在"Track every AI token , then bring your usage to life"下的说明是:An accurate, local-first token usage and cost dashboard for 29 AI coding tools , plus a desktop pet, 4 native widgets, and 15 achievement tracks. No cloud account, no API keys, no setup.。这给出的首先是项目边界,而不是已经完成的生产验证。
适用场景
从 README 的"⚡ Quick Start"和相关条目看,读者可以先判断它是否解决自己的具体问题:🔌 Auto-detected hooks for every supported AI tool you have installed。如果你的目标与这段说明不一致,就不应仅凭项目热度采用它。这里保留原项目名、命令和组件名,方便回到一手来源核对。 README 还列出了另一条可核对的信息:📊 A local dashboard at localhost:7680 with usage trends, model breakdown, cost analysis。这类原文条目可以帮助读者设计试运行步骤,但不能代替自己的环境测试。
工作方式
README 把工作方式分散写在"⚡ Quick Start"等段落中。可确认的线索包括:> Requirements: Node.js 20+ (CLI runs on macOS / Linux / Windows; native desktop app ships for both macOS (menu bar) and Windows (system tray).。这篇整理没有把未写出的架构、性能或安全边界补成结论;真正的运行链仍应结合仓库目录、配置文件和版本标签检查。
安装与第一次运行
第一次安装应从 README 给出的入口开始。当前可复核的命令是: npm i -g tokentracker-cli tokentracker # Open the dashboard tokentracker sync # Manual sync tokentracker status # Check hook status tokentracker status --json # Machine-readable summary (pipe to jq, ingest from AI agents) tokentracker status --light # Plain ASCII table (CI / SSH, no spinner) tokentracker doctor # Health check 如果仓库没有提供命令,本文不会替它编造安装步骤,而是建议先打开 README 的"Track every AI token , then bring your usage to life"部分,确认系统依赖、默认端口和首次初始化动作。
配置与日常使用
日常使用的细节取决于项目实际文档。README 的"⚡ Quick Start"段落提到:That's it. First run installs hooks, syncs your data, and opens the dashboard at http://localhost:7680.。对于配置文件、环境变量、权限和数据目录,当前稿只记录来源明确的部分;未写明的默认值必须在测试环境中验证,并保留可回滚的配置副本。 同一部分还提到:🏠 100% local , no account, no API keys, no network calls (except optional leaderboard)。