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.」。本文只整理倉庫可直接核對的內容,不把 star、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 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「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)。