-
Notifications
You must be signed in to change notification settings - Fork 1
Home
KS-OTO edited this page Sep 21, 2026
·
2 revisions
本手册面向部署者与使用者：把项目跑起来、配好凭据、部署上线、出问题怎么查。
想改代码请读仓库里的 CONTRIBUTING.md
与 开发指南。
| 我想… | 从这里开始 |
|---|---|
| 先跑起来看看 | 快速开始 —— 4 条命令，一条 Key 都不用填 |
| 配一个平台，看到第一张卡 | 快速开始 → 点亮第一张卡 |
| 部署到公网 / 内网 | 部署 |
| 页面 | 讲什么 |
|---|---|
| 快速开始 | 本地跑起来、配第一个平台、验证数据通了 |
| 配置参考 | 全部环境变量逐个说明；站点名 / Logo / favicon / 刷新间隔的自定义 |
| 凭据与多账号 | Cookie 怎么填、$ 转义、多账号编号、账号别名、各平台该开什么权限 |
| 平台支持 | 每家平台调什么接口、字段什么语义、有哪些已知限制 |
| 排查 | 起不来 / 卡片不出现 / 会话「失效」/ Logo 不显示 / 面板拒绝保存变量 |
| 页面 | 讲什么 |
|---|---|
| 部署 | Cloudflare Workers / EdgeOne Makers / Vercel / 自托管 |
| 页面 | 讲什么 |
|---|---|
| 架构 | 3 个接口的契约、错误信封、TTL 缓存分档、目录结构逐文件说明 |
| 设计系统 | token 纪律、数值精度模型、列策略、主题层与对比度基准 |
| 安全模型 | 威胁模型、凭据为什么不落浏览器、报告漏洞的渠道 |
| 开发指南 | 环境搭建、四道门禁、代码铁律、PR 流程、测试约定 |
DeepSeek、火山方舟、智谱、阿里云百炼、模力方舟、百度千帆、OpenRouter、New API 以及 Kimi / MiniMax / OpenCode Go 的余额与额度窗口，散落在各自的控制台里； 有些平台甚至不提供查询 API，只能靠控制台会话 Cookie。想知道「这个月还够不够用」， 得逐个登录、逐个看。
本项目把这件事收敛成一次请求、一个页面，且所有凭据交互都在服务端完成 —— 浏览器侧拿不到任何 Key，页面只渲染掩码。
它不是代理网关：不转发模型请求、不记录对话内容，只做「读余额、读用量」这一件事。
它没有内建用户体系：部署到公网后任何知道地址的人都能看到读数。 生产使用必须在反向代理层加认证，详见 安全模型。
| 词 | 在本项目里的意思 |
|---|---|
| 切片（slice） |
/api/usage 信封里每家平台各占一个键，独立成功 / 独立失败，一家挂不污染其余 |
| 账号（account） | 一组凭据对应的一张卡。同一平台配了 3 个 Key 就是 3 个账号、3 张卡 |
| 窗口（window） | 按时间滚动的额度周期，如火山 Agent Plan 的 5 小时 / 每周 / 每月 |
| 卡面 / 弹窗 | 卡面只放每天要看的读数；身份、元数据、明细表收进卡片右上角的「详情」弹窗 |
| 填充档 / 文字档 | 设计系统中的两类颜色 token。文字一律用文字档 —— 填充档当文字在暗色下只有 2.15:1 |
本手册随代码演进。发现文档与实现不一致时，以仓库里的代码与
docs/design-baseline.md
为准，并欢迎提 issue 指出。