oozzbb/workbuddy2api-hub repository overview

⁠WorkBuddy2API-Hub — 国际版、国内版多账号网关中枢

把腾讯 www.workbuddy.ai⁠（国际版）与 codebuddy.cn⁠（国内版）的原生服务封装成标准 OpenAI 兼容接口（Chat Completions / Responses），并提供默认关闭的实验性 Anthropic Messages 适配；同时补齐多账号调度与运维能力：

• 开箱即用：绿色包自带精简 Python（Windows），双击脚本即启；
• 双区域独立路由：国际版 / 国内版各自配置与调度，看板一键切换，状态落盘；
• 协议与风险：默认支持 Chat Completions、Responses API（Codex）；Anthropic Messages（Claude Code / Anthropic SDK）经协议转换且缓存兼容性尚未验证，默认禁用，仅可显式选择启用；
• 模型目录对齐官方桌面端：剔除补全通道与专线变体，能力与规格按桌面端宣告，上游新模型无需发版即进 /v1/models；
• 设备指纹隔离 (derive_id)：以账号 UID 稳定派生机器码与会话标识，同一账号不漂移、不同账号互不关联；
• 账号接入：看板点链接走浏览器 OAuth；Windows 上还能直接从运行中的桌面客户端导入（加密 token 就地解密），macOS / Linux 可手动粘贴解码密钥后导入；
• 每日自动化：国内版签到 / 成长与积分任务 / 猫猫旅行；国际版每日活跃打卡（真跑完网页会话）；后台调度器按 09:00 & 21:00、22:00、01:00 排程；
• 限额护栏：保留积分 · 每日 Token · 每日积分 · 按模型 Token 四条账号级护栏，单账号独立计数，本地 0 点解封（默认全部关闭）；
• OpenRouter 价估算：把 token 折算成等价花费（人民币 / 美元可切），逐条请求可悬停查看定价来源；
• 多 Key 与出口绑定：每个 Key 可固定走国际版或国内版、可限定模型，用量按 Key 归属；
• Web 看板：指标卡片、模型性能与用量大表、请求流水、账号与任务管理一屏可查。

⁠一、快速启动

⁠1. 本机运行

Windows 双击 start-wb-proxy.bat，保持窗口运行；macOS 双击 start-wb-proxy.command（首次被 Gatekeeper 拦截时右键 →「打开」确认一次），或在终端执行 ./start-wb-proxy.sh [端口]（默认 8788）。

启动后：API 地址 http://127.0.0.1:8788/v1，Web 看板 http://127.0.0.1:8788/。首次启动还没有账号，打开看板点「+ 添加账号 (OAuth)」完成授权即自动入库。

⁠2. 面板访问密码

看板需要面板访问密码（默认 admin），它与 API Key 相互独立：密码只用于打开看板，可在「设置」页修改（或启动时 --panel-password 指定），以 PBKDF2-SHA256 摘要存于 accounts/settings.json（不存明文），登录态只留在浏览器会话里。

本机 / 受信局域网自用可带 ?pwd=面板密码 免手输直接进面板（如 http://127.0.0.1:8788/?pwd=admin）；公网暴露时不要用——密码会留在浏览器历史与反向代理日志里。注意它和局域网共享的 ?key= 不同：?key= 只把 API Key 存给 /v1 用，不会自动登录面板。首次登录后请立即改掉默认密码。

⁠3. 局域网共享

• Windows 双击 start-wb-proxy-lan.bat；macOS 双击 start-wb-proxy-lan.command，或 ./start-wb-proxy-lan.sh [端口] [Key]；
• Base URL http://<本机局域网IP>:8788/v1；带密钥直达面板 http://<IP>:8788/?key=生成的Key；
• API Key：首次启动生成高强度随机 Key，写入 accounts/settings.json 并打印在终端，重启复用；也可用第二个参数指定自己的 Key；
• macOS 防火墙：首次监听端口时选「允许」；macOS 15+ 还要在「系统设置 → 隐私与安全性 → 本地网络」允许终端，./allow-firewall.command 可查看状态并加白。

⁠4. 多 API Key 与出口绑定

「设置」页可管理多个 Key，每个 Key 独立出口——不同客户端各用各的 Key，国内外流量互不干扰：

• 生成 / 绑定：填名称点「生成随机 Key」；可固定走 🌐 国际版或 🇨🇳 国内版，不绑定则跟随看板顶部的全局出口开关；
• 模型限制：可填允许的模型（如 deepseek*、gpt-6-astra，支持 *，逗号分隔），留空不限；不在列表里的请求本机直接返回 400，不送达上游、不消耗额度；
• 区域自检：Key 绑定的出口与模型不匹配时（如国际版 Key 调国内独占的 deepseek-v4-pro）直接返回可读 400，而不是上游晦涩的 WAF 报错；
• 启停 / 删除：可单独启停；删除后密钥立即失效，条目以只读形式留在「设置」页的「已删除」折叠区，历史用量仍显示它的名字；
• 用量归因：「数据看板」页按 Key 列出请求数、Token、缓存命中、积分与模型分布，口径与账号表一致；
• 防冲突：面板保存过 Key 后，启动参数里的 --api-key 自动失效。

⁠5. Docker 部署

预编译双架构镜像（linux/amd64、linux/arm64）发布在 GHCR 与 Docker Hub，无需克隆代码、无需本地编译：

方式一：一键脚本（推荐）

# 官方源（可直连 GitHub 环境）：
curl -fsSL https://raw.githubusercontent.com/ardeyouxipianyi/workbuddy2api-hub/main/quick-deploy.sh | bash

# 国内网络 / NAS 加速（Connection reset 时用）：
curl -fsSL https://gh-proxy.com/https://raw.githubusercontent.com/ardeyouxipianyi/workbuddy2api-hub/main/quick-deploy.sh | sudo bash

NAS（如飞牛 fnOS）普通用户没有 Docker 权限时，把结尾的 bash 换成 sudo bash。再次运行同一条命令即平滑升级，账号与用量数据不受影响。

方式二：NAS / 面板单文件 Compose

在 NAS 或面板的 Compose 界面新建项目并粘贴以下内容保存启动，无需拉取源码：

services:
  wb-proxy:
    image: ghcr.io/ardeyouxipianyi/workbuddy2api-hub:latest   # 或 ardeyouxipianyi/workbuddy2api-hub:latest
    container_name: wb-proxy
    restart: unless-stopped
    ports:
      - "8788:8788"          # 左侧宿主端口可自选；右侧必须与下面的 PORT 一致
    environment:
      - HOST=0.0.0.0
      - PORT=8788
      # - API_KEY=your_secret_key   # 留空则自动生成并打印在启动日志
      - TZ=Asia/Shanghai
    volumes:
      - ./accounts:/app/accounts    # 账号凭证与配置（更新/重建容器不丢）
      - ./usage:/app/usage          # 用量流水日志（更新/重建容器不丢）

更新：面板里点「拉取最新镜像并重启」，或 docker compose pull && docker compose up -d。

方式三：Watchtower 自动静默更新

docker run -d --name wb-proxy-watchtower --restart unless-stopped \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower:latest --interval 86400 --cleanup wb-proxy

补充与排错

• 持久化：./accounts 与 ./usage 由宿主机挂载，更新或重建容器都不丢数据；
• docker run 快捷启动：

  docker run -d --name wb-proxy --restart unless-stopped -p 8788:8788 \
    -v $(pwd)/accounts:/app/accounts -v $(pwd)/usage:/app/usage \
    ghcr.io/ardeyouxipianyi/workbuddy2api-hub:latest
  

  Copy
• 鉴权：容器以 --lan 启动，无显式 API_KEY 时自动生成 Key 写入 ./accounts/settings.json 并打印在日志里：docker compose logs wb-proxy | grep -i "api key"；
• 镜像名要带 registry：写成 ardeyouxipianyi/workbuddy2api-hub 会去 Docker Hub 找并报 pull access denied，正确写法是 ghcr.io/ardeyouxipianyi/workbuddy2api-hub:latest（GHCR 公开包，拉取无需登录）；
• 目录权限：默认以 root（0:0）运行；想以宿主用户跑就设 PUID / PGID（或 --user $(id -u):$(id -g)），并确保两个挂载目录对该 uid 可写；
• 健康检查：镜像自带 HEALTHCHECK（每 30s 探一次 /health），docker ps 的 STATUS 列会显示 healthy / unhealthy；
• 源码构建：docker compose -f docker-compose.build.yml up -d --build。

⁠6. 测试

python tests/run_all.py            # 全部套件
python tests/run_all.py realm      # 只跑名字里含 realm 的

• 152 个套件：112 个 Python + 40 个 JS；JS 需要 PATH 上有 node，缺失时会跳过并提示。
• tests/_mobile_check.py 是独立的 Playwright 手机/桌面布局检查器（需自行安装 Playwright），按需手动运行，不在上面的套件集里。
• CI（.github/workflows/tests.yml）跑同一条命令：Ubuntu 上 python 3.9 与 3.12（3.9 是本项目声称的最低版本），Windows 上 python 3.12；推送 v* tag 时额外断言 tag == 源码版本（-ci 演练 tag 豁免）。

⁠二、核心特性

⁠1. 模型列表对齐官方桌面端

对官方本地配置清单（50+ 底层模型）做清洗：剔除行内补全专用模型（codewise-*、completion-gf、hunyuan-3b/7b 等）与多云专线变体（*-volc、*-lkeap 等），严格对齐官方 Windows 桌面端，并宣告每个模型的上下文窗口、单次最大输出、视觉支持、工具调用与推理档位。

• 🌐 国际版（17 个）：hy4-preview-f、hy3、deepseek-v4.1-flash、gpt-6-astra、gpt-5.6-sol、gpt-5.6-terra、gpt-5.6-luna、gpt-5.5、gpt-5.4、grok-4.7、gemini-3.5-flash、glm-5.3-flash、glm-5.3、glm-5.2、kimi-k3、kimi-k2.6、kimi-k2.8-preview
• 🇨🇳 国内版（14 个）：hy4-preview-f、hy3、deepseek-v4.1-flash、deepseek-v4-pro、glm-5.3、glm-5.3-flash、glm-5.2、glm-5.1、glm-5v-turbo、minimax-m3、kimi-k3-1、kimi-k2.8-preview、kimi-k2.7、kimi-k2.6

清单与上游 GET /v3/config 的 agents[cli].models 保持同步（接口不可用时依次回落到桌面端缓存文件、内置快照）；过滤规则：去掉 5 个档位别名与 auto、去掉 -sg / -x 变体、同名的只留 0.00 倍率那一档。上游新上架的模型无需发版即出现在 /v1/models。

⁠2. 设备指纹隔离（derive_id）

国际版与国内版共用同一套算法内核：以账号 UID 结合固定业务盐值单向哈希派生机器码与会话标识——同一账号每次出站都来自同一台虚拟设备（不随机漂移），不同账号之间彼此独立（阻断跨账号关联风控）。

⁠3. 国内版自动化

• 每日签到：一键完成国内版打卡领积分；
• 自动连续打卡与连登管家：每日定时为国内版账号上报轻量会话事件（复刻客户端 chat_request_send），点亮官方成长中心连登天数与热力墙；自动闭环检查昨日漏签（有补签卡则自动补签保连登）、领取新手礼包/补偿、兑换 7d/14d/28d 连登档位奖励，并自动抽完抽奖次数；
• 成长任务与积分任务：自动批量接取未接任务，构造规范行为事件上报点亮（画布创建、灵感案例、模板使用、模型体验、多轮对话等 14 项），并自动领奖入账；
• 猫猫日常：自动检查旅行状态，在家自动派出、归来自动领奖。

⁠4. 后台常驻调度器

常驻后台，按固定整点执行自动化运维排程：

• 每日 09:00 & 21:00：国内版账号自动签到、对话活跃上报（点亮连登）与猫猫旅行闭环；国际版账号执行每日活跃打卡（领官方每日 30/50 积分福利）；
• 每日 22:00：集中扫描全库账号，Token 剩余寿命不足 2 小时自动调用 Refresh Token 保活；
• 每日 01:00：深夜时段执行夜猫子任务；
• 看板顶部另有「立即巡检保活」与「每日活跃打卡 (国际版)」可随时手动触发。

⁠5. 限额护栏（设置 → 账号限额）

四条账号级护栏放在同一张表里，每行一条、每列一个作用域：

• 全局默认 + 可选分版本：每条护栏的「全局默认」同时作用于国际版与国内版；勾上「分别设置国际版 / 国内版」后可单独设值，某版本留空即继承全局（占位符会写出继承到的数字），取消勾选再保存等于清回继承。
• 每条填 0 表示关闭（默认值）；四条都按本地时间 0 点解封，只在请求路径生效（定时任务不受影响），且都是单账号独立计数。
• 免费 / 付费以各出口自己的模型目录为准，未知模型按付费处理；账号行会显示对应徽章与 模型 · N tok 达限 标记。
• 某个出口的全部账号都达额时，该出口的请求返回 429（文案说明本地 0 点恢复，Retry-After 指向 0 点）。
• 存储：accounts/settings.json 里的一组 limits 映射（{"global": …, "intl": …, "cn": …}，null 表示继承全局）；旧版写在外层的四个扁平键会在第一次读取时自动折入。

⁠6. OpenRouter 价估算（等价 token 花费）

把每条请求的 token 消耗按 OpenRouter 公布的模型价折算成等价金额，回答「这些 token 放在 OpenRouter 上值多少钱」——与账号实际扣除的积分是两个口径，看板里并列显示：

• 总开关（「设置 → 模型价格估算」，默认开启）：关掉后价格列、「API 等价花费」卡片、取价控件与未定价清单一起隐藏，后端也不再取价与折算；重新打开会立刻抓一次价并补算关闭期间的请求（历史日志一个字不改，金额始终是读时算的）。
• 计价口径：输入按缓存命中 / 未命中两档单价拆分，输出单独单价，乘 token 数再按汇率折算；输出的 token 数取上游 completion_tokens（已包含推理 token，不另计）。按条件定价的模型（按输入长度或按 UTC 时段）按每条请求取最紧的那一档。
• 定价来源：OpenRouter 模型目录的模型级公布价（对应它默认路由的那家 provider）。每份价格按内容存成一条「定价策略」，每条请求只记引用了哪条策略，所以之后调价不会改写历史数字；wb_pricing.py 另内嵌一份快照作出厂价。
• 刷新：「设置 → 定价刷新」默认每 5 分钟一次（填 0 关闭）；只有价格真的变了才写策略与时间轴，价格不动时每轮只是一次 HTTP GET。面板可看当前生效策略、上次 / 下次取价时间与失败原因，也能点「立即取价」。
• 新增模型自动取价：候选清单 = 内置目录 ∪ 网关实时目录，上游新上架的名字 5 分钟内进入取价；两次取价之间就被调用也会按需补价（请求路径不发网络请求）。匹配顺序：面板手填覆盖 → 人工覆盖表 → 同名唯一命中 → 变体后缀继承（剥 -lkeap / -taiji / -volc / -sg 等，仍要求唯一命中），继承可在设置里整体关掉。
• 未定价可见：/pricing 列出未定价模型及分类（别名 / OpenRouter 无对应 / 剥后缀后无唯一基准）与相似候选（仅建议，不自动采用），可在「设置 → 定价刷新」为某条手填 OpenRouter id 并登记（写 pricing-overrides.json，不改源码，登记后立即取价）。
• 展示位置：数据看板「API 等价花费」卡片、各账号用量透视与模型性能表最后一列、网关页「估算价格」卡片、最近请求最后一列（悬停可看完整定价链：三档原始单价、汇率、匹配证据、策略 id 与补算标记 *）。
• 人民币 / 美元一键切换（记在浏览器本地）；快照覆盖不到的模型显示 —，不猜数字。

⁠7. 本地网络工具（可选，默认关闭）

Codex App 这类客户端会在 Responses 请求里声明 web_search / web_fetch，而上游没有对应的执行器——声明送上去只会拿到一句 unsupported call。打开「设置 → 本地网络工具」后，网关把那份声明换成自己的同名 function，拦下模型的调用并在本地执行（搜索在 DuckDuckGo / Bing / Wikipedia / Stack Overflow / Google News 之间自动轮换，抓页面抓模型给出的 URL），再把结果喂回模型，最多代跑 3 轮（WB_MAX_WEB_ROUNDS 可调，上限 8）；搜索过程会作为 web_search_call 卡片事件与 url_citation 引用回到客户端。

• 关闭时（默认）声明原样透传，客户端自己声明的搜索工具照常拿到调用；
• 打开后网关会主动出网抓取模型给出的 URL（字面私网地址与解析进内网的域名都会被挡； WB_WEB_TOOLS_PROXY 可以给这组工具单独指定出口代理），每轮代跑都会多跑一次上游、多消耗该账号额度；
• 某个搜寻引擎被限流／拦截时会自动轮换到下一家，只有全部不可用才把明确错误交给模型；常规引擎（DuckDuckGo / Bing）接手时对模型无感，Wikipedia / Stack Overflow / Google News 这类非常规来源会在结果里标明来源；
• 只影响声明了这两个工具的客户端，普通 /v1/chat/completions 客户端不经过这条路径。

⁠8. 智能体一键配置

看板「智能体配置」页可检测本机已装的 AI 客户端，一键把它们的配置指向本网关，改前自动备份、随时字节级还原：

用法：打开看板 →「智能体配置」→ 选 API Key（支持全局默认或绑定特定出口的多 Key）、默认模型与网关地址 → 在检测到的客户端卡片上点「一键配置」；随时可点「一键还原」。

• 非侵入：纯标准库实现的文本级 YAML / TOML / JSON / .env 编辑器，只增量插入或更新 wb-proxy 那段，绝不重排或抹掉用户的注释、缩进与其他 provider 配置；
• 可回滚：写入前自动备份到 accounts/agent-backups/<客户端ID>/（每文件保留最新 10 份），首次接入的原件永久保留；多文件客户端（DSH、Codex）两阶段写入，任一文件失败立即回退；
• 还原：byte-exact 回到首次接入前，网关新建的文件会被清理；若之后手动改过配置，看板会提示「检测到外部修改」，还原仍会覆盖回原件；
• 密钥安全：API Key 只写进客户端自己的本地配置目录（权限仅限当前系统用户），单文件超过 8MB 拒绝编辑。

在另一台机器上接入（远程 / 非本机）：看板的一键配置运行在网关进程里，改的是网关所在机器的配置目录——所以它只在网关本机、且用 127.0.0.1 打开看板时可用（远程访问、容器 / OpenWrt 部署下按设计隐藏入口）。客户端装在别的电脑（网关跑在服务器 / NAS / 路由器上）时，改用自带的配置器 CLI：它在客户端所在的机器上运行，写本机配置、只通过 HTTP 从网关取模型表：

# 1. 取配置器（网关直接提供该文件；也可从仓库 / 绿色包复制 wb_agents.py）
curl -fsSL http://<网关地址>:8788/agents/cli -o wb_agents.py

# 2. 一条命令接入（需要 Python 3.9+，Key 在「设置」页生成）
python wb_agents.py list                                   # 本机装了哪些客户端
python wb_agents.py apply --client codex --base-url http://<网关地址>:8788/v1 --key sk-xxxx
python wb_agents.py restore --client codex                 # 随时字节级还原

• 支持 claude-code / codex / opencode / dsh / crush / zcode 六个客户端，与看板共用同一套写入、备份与还原逻辑（plan() 同时驱动 --dry-run 与真实写入）；
• 默认带 Key 请求一次 GET /v1/models：既为 OpenCode / DSH / Crush / ZCode 填入模型表，也顺带验证 Key（401 = Key 被拒）；网关不可达或想完全离线时加 --no-models；
• 状态与备份存在该机器自己的 ~/.wb-agent-config/（可用 --state-dir 覆盖），每台机器一份，restore 只对执行过 apply 的机器有效；
• --dry-run 只打印将要写入的内容、不落盘；Key 也可用环境变量 WB_PROXY_API_KEY 传入。

模块内部设计与新增客户端的方法见 docs/CONTRIBUTING-智能体配置.md⁠。

⁠9. 剩余用量估算（数据看板 → 剩余用量估算）

上游按 24 小时窗口给「账号 × 模型」配额（用满时 429 / code 6004 会带上重置墙钟），但从不告诉你这个窗口的预算是多少。看板新增的「剩余用量估算」区块把它反推出来：

• 预算 = 撞线账号窗口用量的平均：账号撞线（收到带重置时刻的 429）的那一刻，它在该模型上「自窗口起点以来的成功用量」就是预算的一个样本；按区域聚合、先按账号平均再跨账号平均。样本在 429 处理的那一刻就记进 usage/limit-events.jsonl（重试循环里只有最后一个账号会留下带归属的 429 用量行，光靠日志会漏掉大部分撞线），历史日志里带账号的 429 行作为补充，两者按「账号 + 模型 + 重置时刻」去重。
• 已用从每个账号自己的重置时刻起算：窗口起点取该账号该模型最近一次重置时刻；重置时刻在未来的组合（正在冷却）剩余记 0 并显示恢复时间。
• 没有撞线记录的组合标「按 24h 估算」：窗口起点未知时按最近 24 小时用量统计——窗口起点必然落在最近 24h 内，所以这是剩余量的下界（偏保守，不会高估）。
• 接口 GET /usage/remaining（需面板会话）返回 budgets（每个区域 × 模型的预算均值 / 区间 / 样本数）与 rows（每个账号 × 模型：已用、预算、剩余、窗口起点、是否冷却、是否估算），区块只读不写，不参与请求路径（唯一的请求路径接触点是撞线时记一行事件）。
• 查询侧不做重复计算：每个「账号 × 模型」的用量缓冲是时间戳 + 累计和两个列表（窗口求和 = 两次二分 + 一次相