Skip to content

Getting Started

KS-OTO edited this page Sep 21, 2026 · 1 revision

快速开始

目标:10 分钟内在本机跑起来,并看到一张带真实读数的卡片。

0. 前置条件

依赖 版本 为什么
Bun 1.2+ 唯一的包管理与脚本运行器
Node.js ^22.18.0 || >=24.12.0 只有 Playwright(E2E)需要;日常开发与部署都不需要
bun --version && node --version

1. 克隆并安装

git clone https://github.com/KS-OTO/tracking-llm-plan-usage.git
cd tracking-llm-plan-usage
bun install

2. 准备环境变量文件

cp .env.example .env

.env 里有全部变量的注释版说明。先什么都不填,留着下一步用。

3. 启动

bun run dev

打开 http://localhost:5173。

bun run dev 是单进程:server/app.ts 已挂载进 Vite dev server,不需要另开后端 (bun run dev:all 把前端与后端分开跑,仍然可用)。

你现在应该看到什么

一个能正常渲染、但每张卡都是「未配置」空态的页面 —— 这是预期行为,不是报错。

设计上,未配置的平台返回 NOT_CONFIGURED 并渲染成中性空态,而不是把整页变成错误墙; 一个平台失败也不会影响其他平台出卡。

导航里的「更新于 / 下次刷新」会正常走动 —— 即使没有任何凭据,刷新循环照样在跑。

4. 点亮第一张卡

拿 DeepSeek 做第一个例子,因为它是所有平台里最简单的:只要一个 Key。

  1. 到 https://platform.deepseek.com/api_keys 创建一个 API Key。

  2. 写进 .env:

    DEEPSEEK_API_KEY=sk-你的真实key
  3. 重启 bun run dev(环境变量在进程启动时读取)。

  4. 切到「余额账户」Tab —— DeepSeek 卡出现了,卡面是总余额。

卡上只放每天要看的读数。账号身份、明细表这类信息在卡片右上角的**「详情」**弹窗里。

一次配多家

.env 里的变量是独立的,配齐哪几家就显示哪几家。回本的平台一次配完,然后重启一次即可。

各家需要的变量速查:

平台 变量
DeepSeek DEEPSEEK_API_KEY
火山方舟 Agent Plan VOLC_ACCESS_KEY_ID + VOLC_SECRET_KEY
智谱 GLM ZHIPU_API_KEY
阿里云百炼(资源包) ALIYUN_ACCESS_KEY_ID + ALIYUN_SECRET_KEY
阿里云百炼 Token Plan 同上;个人版另加 ALIYUN_TOKENPLAN_COOKIE
模力方舟 GITEE_AI_API_KEY(代金券另加 GITEE_AI_SESSION_COOKIE)
百度千帆 BAIDU_ACCESS_KEY_ID + BAIDU_SECRET_KEY
OpenRouter OPENROUTER_API_KEY
New API(自托管) NEWAPI_BASE_URL + NEWAPI_TOKEN
订阅套餐 KIMI_API_KEY / MINIMAX_API_KEY / OPENCODE_GO_API_KEY
  • 每个变量是什么意思 → 配置参考
  • 需要 Cookie 的平台怎么填 → 凭据与多账号 (这一页有坑,配 Cookie 前必读)
  • 同一平台多个账号 → 变量名加 _N 后缀,见 多账号

5. 验证数据真的通了

页面上的「详情」弹窗里能看到完整读数即说明上游调用成功。也可以直接打接口:

curl -s http://localhost:5173/api/status | head -c 800
curl -s http://localhost:5173/api/usage  | head -c 800
  • /api/status 只回配置状态,0 次上游调用,所以它永远很快 —— 它不能用来判断凭据对不对。
  • /api/usage 才会真的去查上游。某个平台的切片里带 error / code 就说明这一家失败了。

6. 本地跑生产模式

bun run build          # vue-tsc 类型检查 + 构建到 dist/
bun run server         # Bun 服务:同一端口提供 API 与静态页面

打开 http://127.0.0.1:8787。

下一步

我想… 去哪
部署到公网或内网 部署
改站点名 / 换 Logo / 调刷新间隔 配置参考 → 站点自定义
某张卡一直不出现 / 报错 排查
参与开发 开发指南

⚠️ 本地跑没问题不代表可以直接上公网。本项目没有内建访问控制, 任何知道地址的人都能看到全部余额读数。上线前先读 安全模型。

Clone this wiki locally