WorkBuddy2API

把腾讯 CodeBuddy 账号变成 OpenAI 兼容 API 的多账号网关
OAuth 登录 · 账号池轮转 · 熔断与冷却 · 会话粘性 · 定时签到保活 · 流式/非流式

📖 项目简介

WorkBuddy2API 是一个自托管的 OpenAI 兼容反向代理网关，将腾讯 CodeBuddy（copilot.tencent.com）账号包装为统一的 /v1/chat/completions 服务。

官方不提供 OpenAI 形态的开放 API，本项目通过 OAuth 设备授权 获取账号凭证，在网关侧做 token 自动刷新、账号池调度与流量治理；
面向 个人多账号 场景：多账号共享、单号故障自动换号、冷却/熔断防止雪崩、会话粘性保证多轮上下文不跳号；
对客户端只暴露 OpenAI 兼容接口，现有 SDK / 前端 / 工具 零改造接入。

⚠️ 合规须知：本项目是非官方网关，使用 CodeBuddy 账号作为上游，仅限本人授权账号、本机/私有环境测试。详细边界见安全与合规与 SECURITY.md。

📦 本仓库定位：Sliverkiss/workbuddy2api 的私有衍生版本。在 MIT 许可下保留上游版权声明，并追加了本地管理控制台、请求日志缓冲、签到历史等扩展（详见本仓库扩展）。上游更新请从原仓库获取。

👀 预览

仪表盘	账号池

成长计划	请求日志

设置

截图均来自运行中的真实网关（/ui），所有可识别信息已脱敏：API Key → YOUR_API_KEY，账号昵称 → 账号 A / 账号 B，账号 UID 缩写 → a1b2c3d4 / e5f6g7h8。脱敏在 API 响应层完成（截图前拦截 fetch 改写 JSON），因此表格、下拉框、状态行里都不会残留真实值。

🗺️ 架构总览

等价的 Mermaid 版本（便于在源码里修改）

flowchart LR
    Client["客户端 / SDK\nOpenAI 兼容请求"] --> H

    subgraph GWI["WorkBuddy2API 网关 :7863"]
        H["HTTP Handler\n鉴权 · 日志 · 换号轮转"] --> P
        H --> S
        P["账号池\n三因子加权 · 熔断 · 冷却 · 租约"] --> U
        S["会话粘性路由"] -.绑定镜像.-> REDIS
        T["定时调度\n签到 09/21 · 保活 22 · 旅行 30m"] --> P
        U["上游 Client\nChatHTTP 流式 · 短 RPC"]
    end

    P -. "读凭证 (0600)" .-> AUTH[("auths/*.json")]
    P -. "状态镜像" .-> REDIS[("Upstash Redis\n可选")]
    U -->|"v2/chat/completions (SSE)"| CB["CodeBuddy\ncopilot.tencent.com"]
    U -->|"billing / auth / models"| CB

✨ 核心能力

能力	说明
🔑 OAuth 一键登录	`login.sh` 设备授权流程（无 PKCE），自动落盘凭证并重启容器
🔄 多账号池	三因子加权随机选号（积分比例 ×10 + 闲置补偿 + 成功率 ×3），Top-5 候选 + 防惊群
🛡️ 熔断与冷却	429/404 软冷却、402/余额不足硬冷却至次日 04:00、连续失败指数退避熔断、在途租约限流
🧲 会话粘性	同一会话（`conversation_id`）尽量绑定同一账号，TTL 滚动续期，失败自动解绑
⏰ 定时任务	每日 09:00 / 21:00 自动签到 + 余额查询解冻 + 猫猫旅行（派猫/领奖）；22:00 全账号 token 刷新保活
⚡ 流式 + 非流式	上游 SSE 逐帧规范化透传；出站强制 `stream:true`，非流式由本地聚合为单响应
🧠 推理模型兼容	`reasoning_content` 白名单保留、工具调用（`tool_calls`）按 index 合并、effort 自动降级
📊 可观测	每请求一行表格日志（TTFB/token 速率/uid）；`/healthz` 带 `service` 身份标识可接负载均衡/宿主探活
💾 状态持久化	池状态本地原子落盘 + Upstash Redis 异步镜像（可选），重启择新恢复
🖥️ 本地管理控制台	`/ui` 单页 WebUI（本仓库扩展）：仪表盘 / 账号池 / 猫猫旅行 / 成长计划 / 请求日志 / 任务历史 / 设置
🗑️ 指纹脱敏	出站请求体黑名单指纹字段清洗（可关闭）

🚀 快速开始

环境要求

一个（或多个）已注册的 CodeBuddy 账号，用于 OAuth 登录
宿主机 7863 端口空闲

运行方式三选一，按上手难度排序：

方式	需要什么	适合谁
A. 下载预编译包	什么都不装，解压双击	Windows 用户 / 想最快跑起来
B. 从源码构建	Go 1.22+	想改代码 / 非 amd64 架构
C. Docker Compose	Docker	服务器部署 / 想要容器隔离

预编译包由 GitHub Actions 在干净环境里构建（-trimpath，不含作者机器路径），每次打 tag 自动更新。见 Release 页。

A. 下载预编译二进制（推荐）

到 Releases 下载对应平台的包：

平台	文件
Windows (x64)	`wb2api-server-windows-amd64.zip`
Linux (x64)	`wb2api-server-linux-amd64.tar.gz`

Windows：

1. 解压到一个固定目录，例如 D:\wb2api\
2. 把 config.example.json 复制为 config.json
3. 用编辑器改 config.json 里的 "api_key"（改成你自己的强随机串）
4. 双击 start.bat

解压后的目录应该长这样：

D:\wb2api\
├── start.bat
├── wb2api-server.exe
├── config.example.json
└── config.json          <- 由 config.example.json 复制并改名而来

首次启动会自动创建 auths\（账号凭证）与 data\（池状态、日志、历史）两个目录。浏览器打开 http://127.0.0.1:7863/ui 即进入本地控制台，在「账号池 → ＋添加账号」里完成 OAuth 登录。

start.bat 会自动在两个位置找可执行文件，所以 Release 包（exe 与 bat 同级）和源码检出（exe 在 bin\）两种布局都能直接双击运行，不必手动调整目录结构。

Linux：

tar xzf wb2api-server-linux-amd64.tar.gz
cd wb2api-server-linux-amd64
cp config.example.json config.json
# 编辑 config.json 设置 api_key
chmod +x wb2api-server
./wb2api-server -config config.json

校验下载完整性（可选）：Release 附带 SHA256SUMS.txt
# Windows
Get-FileHash .\wb2api-server-windows-amd64.zip -Algorithm SHA256
# Linux
sha256sum -c SHA256SUMS.txt --ignore-missing
⚠️ 本仓库的二进制未经代码签名。Windows SmartScreen 可能提示"未知发布者"，Linux 无包管理器集成。介意的话请用方式 B 自己编译 —— 那也是本项目最推荐的验证方式。

B. 从源码构建

需要 Go 1.22+。

git clone https://github.com/Practice019/workbuddy2api.git
cd workbuddy2api
cp config.example.json config.json
# 编辑 config.json 设置 api_key

CGO_ENABLED=0 go build -trimpath -ldflags="-s -w" -o bin/wb2api-server ./cmd/server
./bin/wb2api-server -config config.json

Windows 上把最后两行换成：

$env:CGO_ENABLED = '0'
go build -trimpath -ldflags="-s -w" -o bin\wb2api-server.exe .\cmd\server
.\bin\wb2api-server.exe -config config.json

-trimpath 不要省：不加它，二进制里会写进你本机的绝对路径与 Go module 缓存路径（如 C:/Users/<你的用户名>/go/pkg/mod/...）。自己用无所谓，但若要把产物分享给别人就该去掉。

构建完成后同样可以双击 start.bat（它会在 bin\ 与同级目录两处自动查找可执行文件）。

2. 登录添加账号

./login.sh
# 1) 脚本输出授权 URL
# 2) 浏览器打开完成登录
# 3) 回到终端按 y → 自动签到 → 落盘 auths/workbuddy-<uid>.json → 重启容器

多账号只需重复执行；账号池自动发现 auths/ 下新增凭证文件（容器启动时 SyncToDir 对齐）。

也可以完全在网页里添加：打开 /ui → 「账号池」→ 「＋添加账号」，走同样的 OAuth 流程且热加载进池，无需重启。

C. Docker Compose

docker compose up -d --build

Windows 本机直接运行（不走 Docker）：

仓库根目录有一个 start.bat，双击即可启动：

start.bat

需要额外参数时（比如换一份配置）：

start.bat -config other.json

start.bat 必须保持纯 ASCII。cmd.exe 按系统 OEM 代码页（中文 Windows 为 936/GBK）解析 .bat 内容，UTF-8 的中文字节会被误解码并破坏语法。中文说明在 README，不写进 bat。详细见 bat 内的注释。

等价的命令行启动方式（等价于双击 start.bat）：

cd path\to\workbuddy2api
.\bin\wb2api-server.exe -config config.json

其中 -config config.json 可以省略 —— 它本就是程序自身的 flag 默认值（见 cmd/server/main.go）；真正决定成败的是前面那句 cd。

4. 验证

# 健康检查（无可用账号时 503）；service 字段用于确认打到的是本网关
curl -s http://localhost:7863/healthz
# {"healthy":2,"total":3,"service":"workbuddy2api"}

# 模型列表
curl -s http://localhost:7863/v1/models \
  -H "Authorization: Bearer your-api-key"

# 账号状态（汇总 + 每账号详情）
curl -s http://localhost:7863/status \
  -H "Authorization: Bearer your-api-key"

# 流式聊天
curl -sN http://localhost:7863/v1/chat/completions \
  -H "Authorization: Bearer your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"model":"deepseek-v4-flash","messages":[{"role":"user","content":"hi"}],"stream":true}'

# 非流式聊天（本地聚合）
curl -s http://localhost:7863/v1/chat/completions \
  -H "Authorization: Bearer your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"model":"deepseek-v4-flash","messages":[{"role":"user","content":"hi"}],"stream":false}'

⚙️ 配置说明

config.json 是网关的单一写入口。config.example.json 是仓库随附的最小可工作模板；启动时若该文件不存在则用纯默认 + 环境变量。

完整的字段表见下表，所有字段均可省略（省略则用默认值）；环境变量优先级最高，可用于临时覆盖（见后文）。

完整字段以 config.example.json 为样例（下表为各字段含义）。

{
  "listen": ":7863",
  "api_key": "your-api-key-here",
  "auth_dir": "./auths",
  "state_file": "./data/state.json",
  "cooldown": { "soft_rate": "60s" },
  "schedule": {
    "checkin_hours": [9, 21],
    "keepalive_hours": [22],
    "checkin_enabled": true,
    "keepalive_enabled": true
  },
  "upstream": {
    "timeout_seconds": 120,
    "header_timeout_seconds": 120,
    "idle_timeout_seconds": 300
  },
  "features": { "sanitize_blacklist_fingerprints": true },
  "upstash": { "url": "", "token": "" },
  "pool": {
    "max_in_flight": 3,
    "breaker_threshold": 3,
    "breaker_cooldown": "30m",
    "breaker_cooldown_max": "6h",
    "idle_weight_per_hour": 0.5,
    "idle_weight_max": 5.0
  },
  "session_sticky": { "enabled": true, "ttl": "30m", "gc_interval": "5m" }
}

字段速查

字段	默认	说明
`listen`	`:7863`	HTTP 监听地址
`api_key`	空	网关鉴权密钥；空 = 不鉴权直接放行（公网必须设置）
`auth_dir`	`./auths`	账号凭证目录
`state_file`	`./data/state.json`	账号池状态持久化文件
`cooldown.soft_rate`	`60s`	429/404 软冷却时长
`schedule.checkin_hours`	`[9, 21]`	每日本地时区整点签到 + 余额查询；收尾顺带跑一趟猫猫旅行。空数组/`null` = 未配置回落默认（不是禁用）
`schedule.keepalive_hours`	`[22]`	每日本地时区整点刷新 token 保活。空数组/`null` 同上
`schedule.checkin_enabled`	`true`	签到总开关；`false` 真正关掉签到（猫猫旅行随之停摆，见下）
`schedule.keepalive_enabled`	`true`	token 保活总开关；`false` 关掉保活
`upstream.timeout_seconds`	`120`	短 RPC（刷新/签到/余额/模型）总时长上限
`upstream.header_timeout_seconds`	回落 `timeout_seconds`	聊天首字节前（响应头）上限
`upstream.idle_timeout_seconds`	`300`	聊天流中空闲上限（活跃续命，静默断流）
`features.sanitize_blacklist_fingerprints`	`true`	出站请求体黑名单指纹脱敏
`upstash.url` / `token`	空	空 = 纯内存模式（Noop 降级，功能照常）
`pool.max_in_flight`	`3`	单账号最大在途请求数（`0` = 不限）
`pool.breaker_threshold`	`3`	连续失败触发熔断阈值
`pool.breaker_cooldown`	`30m`	熔断基础退避时长
`pool.breaker_cooldown_max`	`6h`	指数退避封顶
`pool.idle_weight_per_hour`	`0.5`	闲置补偿：每小时未使用 +0.5 权重
`pool.idle_weight_max`	`5.0`	闲置补偿权重封顶
`session_sticky.enabled`	`true`	会话粘性路由开关
`session_sticky.ttl`	`30m`	会话绑定 TTL（滚动续期）
`session_sticky.gc_interval`	`5m`	过期绑定 GC 周期

上游超时语义（三段各归其位）

字段	作用对象	默认	行为
`timeout_seconds`	短 RPC（token 刷新 / 签到 / 余额 / 模型列表）	`120`	总时长硬上限，到期报错走换号/熔断
`header_timeout_seconds`	聊天 SSE 首字节前	`120`	由 `Transport.ResponseHeaderTimeout` 约束；超时 = 换号重发
`idle_timeout_seconds`	聊天 SSE 流中空闲	`300`	活跃吐数据续命不掐；静默超时才断流释放租约

聊天流（stream true/false 均同）没有总时长上限：聊天使用 Timeout=0 的专用 client，长思考/长输出（如超长 reasoning）不会被 120s 掐断。

环境变量覆盖

加载顺序：JSON 文件 → WB2A_* 环境变量（变量非空才覆盖）：

WB2A_LISTEN · WB2A_API_KEY · WB2A_AUTH_DIR · WB2A_STATE_FILE · WB2A_SOFT_RATE（duration） · WB2A_TIMEOUT_SECONDS · WB2A_HEADER_TIMEOUT_SECONDS · WB2A_IDLE_TIMEOUT_SECONDS · WB2A_SANITIZE_FINGERPRINTS（bool）

🧠 账号池与流量治理

账号状态机

每个账号由三个正交维度描述：

维度	字段	说明
健康	`disabled` / `until` / `breakerUntil`	`healthy = !disabled && !until && !breakerUntil`
并发	`inFlight`	在途租约（运行态，不持久化），上限 `max_in_flight`
统计	`successCount` / `errTotal` / `lastUsed`	供成功率权重与闲置补偿

  Healthy ──429/404 软冷却 / 402 硬冷却 / 5xx 熔断──▶ 冷却·熔断期
     ▲                                                │
     │       到期自动恢复 / 签到余额解冻 / 成功清零     │
     └────────────────────────────────────────────────┘

  Disabled（session 死亡，永久，需人工重新 login.sh）

错误分类与处置

分类	触发条件	账号处置	恢复
余额不足	HTTP 402 / body 含余额关键词	硬冷却到次日 04:00（本地时区）	签到（09/21 点）余额恢复自动解冻
频控	HTTP 429	软冷却 `soft_rate`（60s）	到期自动恢复
Session 失效	body 含 `Offline user session not found` / `12153`	永久禁用	人工重新登录
上游 404	HTTP 404	软冷却（60s）	到期自动恢复
服务端错误	HTTP ≥500	喂连续失败计数，达阈值熔断	熔断到期 / 成功清零
客户端错误	其余 4xx / 业务 `code≠0`	不处罚，换号重试	即时

熔断器：所有冷却入口（429/404/402）与 5xx 共用唯一连续失败计数器 fails；累计达 breaker_threshold（默认 3）触发熔断，退避 breaker_cooldown × 2^retryCount，封顶 6h；成功清零。

选号策略

过滤：禁用 / 冷却 / 熔断 / 在途占满账号不参与
取 Top-5 候选（按三因子权重降序，积分只是因子之一）
三因子加权随机： weight = credits 比例 ×10 + idleWeight + successRate ×3
- credits 比例 = 该号积分 / 候选集最大积分
- idleWeight = min(闲置小时 × idle_weight_per_hour, idle_weight_max)，从未使用给满分
- successRate = successCount/(successCount+errTotal)，无记录给中性 1.5
防惊群：跳过 100ms 内刚被选中的账号；全冷却时从非禁用、非余额耗尽的软冷却/熔断账号中选最早到期者顶班

会话粘性

同一会话尽量复用同一账号，多轮对话不跳号：

会话键提取顺序：metadata.conversation_id → metadata.user_id → 顶层 conversation_id
TTL 滚动续期（默认 30m），GC 周期 5m；绑定可镜像到 Redis（7 天）防重启丢失
请求失败自动解绑；成功后绑定跟随最终成功账号

定时任务

任务	开关	时刻（本地时区）	行为
签到	`schedule.checkin_enabled` 默认 `true`	`checkin_hours` 默认 `[9, 21]` 整点	签到 + 余额查询；余额恢复则解冻冷却账号；收尾顺带跑一趟猫猫旅行
保活	`schedule.keepalive_enabled` 默认 `true`	`keepalive_hours` 默认 `[22]` 整点	全账号刷新 token；session 失效自动禁用

容器时区由 TZ 控制（compose 默认 Asia/Shanghai）。

关闭定时任务

用 schedule.checkin_enabled / schedule.keepalive_enabled 显式关闭，两者互相独立：

"schedule": {
  "checkin_hours": [9, 21],
  "keepalive_hours": [22],
  "checkin_enabled": false,
  "keepalive_enabled": true
}

上例：只关签到，保活照常 22:00 跑。两个都设 false 则调度器无任何时点可等， Run 不空转、直接阻塞等待退出信号（不会忙等空烧 CPU）。

几条必须知道的语义：

为什么用独立开关，而不是把小时数组留空：空数组与 null 在本项目里一贯表示 「未配置 → 回落默认」（[9, 21] / [22]），不是「禁用」。沿用该语义可保证老 config 行为逐字不变；真正关闭请用 *_enabled: false。
关签到 = 猫猫旅行也停：旅行没有独立开关，它搭签到时点便车执行（见下节）。想让旅行继续跑就不能关签到——如需保留旅行请把 checkin_hours 调成你想要的时点。
禁用不会擦除小时配置：checkin_hours 原样保留，改回 true 即恢复原时点，无需补配。
小时值必须是 0-23：写了 -1、25 之类的非法值会在启动时直接报错并提示改用开关（不做静默兜底，避免你以为关掉了、实际却在别的整点照常执行）。
开关只影响本进程的定时排程，不改变池内冷却/熔断/禁用等既有状态机行为；独立的一次性工具（signin.sh / cmd/signin）是另一个进程，不受本开关约束。
关签到的连带影响：签到的余额查询会「余额恢复即解冻」被硬冷却的账号（402 余额不足），关掉后这类账号只能等硬冷却次日 04:00 自然到期才回到池中——当日余额回补不再提前解冻。

猫猫旅行（随签到时点合并执行）

对池内每个可用账号在签到时点（checkin_hours，默认 9/21 点）单趟推进一次，每趟只做一个动作，不轮询不等待：

为什么不再单独排程：每日上限按「派出」计 1 次/天，奖励在派出时即锁定、晚领不丢分；旅行周期以小时计，30 分钟粒度的额外巡检不会多派一次，只是白白增加上游请求。合并到签到时点后每账号每天 2 趟，签到 → 派猫 → 领奖一次跑完。（签到排在旅行之前：先签到解冻冷却账号，本轮旅行才能覆盖到它们。）

探测结果	动作
无猫（`buddy` 为 `null`）	先同意协议（幂等），再尝试领养；过门槛则 +300 积分并获得猫
`state=idle` 且今日未派出	派出 `location_id=4`（古镇客栈；4 个地点收益/时长区间相同，无最优解）
`state=arrived`	领取到站奖励（带 `record_id`）
`state=traveling` / 今日已达上限 / 未知状态	跳过

领养门槛：conversation 门槛未达标时上游返回 HTTP 400 first_buddy task not completed yet，属预期行为——每账号每自然日只尝试一次，失败后当日静默跳过，跨日（00:00 CST）自动重试；记录仅存内存，进程重启后清零。
限速：账号间间隔 800ms（46 个账号约 40s），避免触发上游风控。
每自然日 1 次派出：按 CST（Asia/Shanghai）自然日重置，与容器 TZ 无关。
失败隔离：单个账号查询/动作失败只跳过该账号本轮，不中断其他账号；401 不做强刷（token 刷新交 22:00 保活），失败信息按 travel <uid>: <动作>: <错误> 落日志。
关闭：旅行无独立开关——它随签到一起跑，不再单独排程。因此 schedule.checkin_enabled: false 关掉签到的同时，旅行也一并停摆；只想调整时点（而非关闭）请改 checkin_hours。

签到与保活配到同一小时（如都含 22 点）时，两类任务都会执行。

🔌 API 端点

端点	鉴权	说明
`POST /v1/chat/completions`	Bearer（`api_key` 非空时）	OpenAI 兼容补全；流式/非流式；请求体上限 8 MiB
`GET /v1/models`	Bearer（`api_key` 非空时）	模型列表（动态拉取，缓存 1h；失败回落静态表 + 5min 负缓存）
`GET /status`	Bearer（`api_key` 非空时）	账号状态汇总 + 每账号详情（积分/冷却/熔断/在途/粘性）
`GET /healthz`	无	健康检查：有 healthy 且未占满账号返回 200，否则 503；响应带身份标识（见下）

鉴权规则：仅当 api_key 非空才校验 Authorization: Bearer <api_key>；api_key 为空时上述端点直接放行；/healthz 恒无鉴权。

/healthz 响应示例（200/503 同结构，仅状态码与计数变化）：

{"healthy": 2, "total": 3, "service": "workbuddy2api"}

响应同时带 X-Service: workbuddy2api 头。这两个身份标识用于区分本网关与同端口上可能残留的其他服务——后者即使返回 2xx 也不会带该字段/头，宿主探测据此避免"假成功"。

宿主健康探测指引

宿主程序（如 workbuddy-switch 托管网关子进程）探活时，"端口通 + 返回 2xx" 不足以证明打到了自己的网关：同端口可能残留旧版本进程或别的服务，对方返回 2xx 会造成假成功。按校验强度从高到低有两种做法：

① 强校验（推荐）：/status + api_key

# 期望 200；若返回 401 则说明对面的 /status 不认这个 api_key —— 不是自己的网关
curl -s -o /dev/null -w '%{http_code}\n' \
  -H "Authorization: Bearer <api_key>" \
  http://127.0.0.1:7863/status

/status 挂在鉴权中间件上：只有持有正确 api_key 的本网关才会返回 200，旧服务/其他服务只会返回 401（或 404）。注意前提：本网关 api_key 非空才具备这个判别力； api_key 为空时 /status 直接放行，退化为弱校验。

宿主判定建议：200 → 健康；401 → 不是自己的网关（端口被占）；连接失败 → 未就绪； 5xx → 网关已就位但池不可服务（可再叠加 /healthz 的 503 语义）。

② 弱校验（无凭据场景）：/healthz + service 字段

# 必须同时校验 service 字段；只判断 HTTP 状态码仍可能假成功
curl -s http://127.0.0.1:7863/healthz | grep -q '"service":"workbuddy2api"'

适合负载均衡器 / 容器编排这类不该持有 api_key 的探活方（/healthz 恒无鉴权， 200=可服务、503=池内无可服务账号）。判据是响应体 service == "workbuddy2api"；响应头 X-Service 可用于只读头部的探活实现。若对面返回 2xx 但缺该标识 → 判为异常。

容器自带的 HEALTHCHECK 用的就是 ②（仅进程内自检，够用）；宿主做跨进程归属确认时用 ①。

流式行为细节

出站请求强制 stream:true；SSE 帧按 OpenAI 规范白名单重建（reasoning_content 保留、工具调用按 index 合并、未知字段剥离）
保证恰好一个 data: [DONE]（上游漏发时兜底补写）；空流先写一帧 error 再补 [DONE]；error 帧原样透传

🖥️ 管理控制台（本仓库扩展）

本节所述内容为本仓库在原始上游版本之上的扩展，上游 Sliverkiss/workbuddy2api 不包含这些能力。

浏览器打开 http://127.0.0.1:7863/ui 即可使用。单文件控制台，//go:embed 打进二进制，零外部依赖、零 CDN，断网可用。

页面构成

面板	内容
API 接入信息	接入地址 / API Key / 鉴权头 / 服务名，四张卡片点击即复制；端点清单表；可复制的 curl 示例
调用统计	进程内请求总数、成功/失败、成功率、平均 TTFB、平均总耗时、输出 token、按模型调用次数
网关状态	账号总数 / 健康 / 冷却 / 禁用 / 在途占满 / 粘性会话 / Redis 模式 / healthz 码
账号池	每账号昵称、积分、状态徽章、token 剩余有效期、今日签到结果、成功次数、熔断、在途 + 行内操作按钮
调度	下次任务名与倒计时、签到时点/保活时点（只读，开关统一在「设置」）
猫猫旅行	选账号后查状态 / 派猫 / 领奖，结果以中文呈现（猫名、状态、今日是否已派出、到站可领积分）
成长计划	账号汇总表 + 账号下拉框选一个账号看任务明细；四个视图（待接单 / 进行中 / 已完成 / 全部）；每条任务带达成条件与怎么做两段说明；行内领取奖励 / 接单 / 兑换 / 补签 / 开盲盒 / 抽奖，节头可「全部领取」
请求日志	每请求一行（时间/模型/模式/状态/uid/TTFB/token/耗时），2s 增量刷新，缓冲 2000 条；可切「历史（落盘）」视图
任务历史	签到/保活/旅行/积分/成长结果，保留 30 天，可按类型筛选，区分手动与定时触发
可用模型	上游模型目录（1h 正缓存 / 5min 负缓存），可强制回源刷新
对话测试	选模型、流式/非流式、Enter 发送，显示耗时与 token 用量
设置	唯一可写配置的入口：调度时点、自动动作开关、各类间隔、日志保留天数，保存即持久化

账号操作

＋添加账号：页面内走完整 OAuth 设备授权流程——弹出授权链接 → 每 2.5s 轮询 → 成功后自动写 auths/workbuddy-<uid>.json 并热加载进池，无需重启
重载 auths 目录：手工拷入的凭证即时生效
行内操作：签到 / 刷新积分 / 保活 / 启用·禁用 / 清冷却 / 移除
移除采用两段确认：第一次问是否移出池（默认只出池、保留凭证文件），第二次才问是否连文件一起删；删除路径强制校验必须落在 auths/ 目录内

成长计划：任务状态与「奖励到账」是两件事

上游把「任务达成」和「发放奖励」拆成了两步，这是最容易误判的地方（我一开始就判错了）：

状态	含义	可做的动作
`not_accepted`	未接单	接单（接进列表开始计进度，不发奖励）
`accepted`	已接单，进度未达标	无
`in_progress`	已接单且进度已推进但未达标	无
`completed`	条件已达成，奖励尚未发放	领取奖励
`claimed`	奖励已领取	无

`not_accepted` 只在「领到第一只 Buddy 之前」出现

这一点很反直觉，值得单独说清楚 —— 官方前端没有「接单」按钮，因为它把 not_accepted 当作一个几乎瞬时、用户不需要关心的中间态：

账号完成 first_buddy（领取一只 Buddy）之前，其余 17 个任务是 not_accepted；
一旦 first_buddy 变 claimed，其余任务会被上游自动接单（变 accepted）；
之后你在官网看到的只有「进行中 / 已完成」两类，再也看不到未接单。

三个真实账号的实测分布（not_accepted 全为 0，账号名已脱敏）：

账号	accepted	in_progress	claimed
账号 A（重度使用）	4	1	13
账号 B（中度使用）	16	0	2
账号 C（新号）	17	0	1

所以本网关的「接单」能力不是多余的，它只在一个很窄的窗口里有价值： 账号刚建、还没领 Buddy 时，可以一键把 17 个任务接进列表（否则它们连进度都不显示）。过了这个窗口，接单按钮会因为 acceptable_count == 0 而自动置灰 —— 你看到的「没有接单操作」正是这个原因，不是功能缺失。

想彻底不用管它：打开「设置 → 成长中心自动动作 → 自动接单」，守卫轮会在每轮自动处理这个窗口期的任务。默认关，因为它是纯登记动作、不产生任何实际进展，由用户决定是否让网关代劳。

completed 不代表奖励已到账。实测：某账号有 10 个 completed 任务（面值 1350 分），调 POST /v2/activity/growth/tasks/{task_code}/claim 后状态变 claimed、积分 +1350。所以「做完任务积分不涨」不是没做到，而是少了一次领取。
领取是逐个任务的（上游没有批量接口），已领过的返回 already_claimed=true 且 credit=0，这是幂等成功、不是错误。
自动领奖默认开启（admin.growth_auto_claim，也可写 growth_auto_claim_tasks）。它在成长守卫每轮先于其它动作执行，并在领取成功后就地刷新账号积分，否则界面上的积分要等下一次定时刷新才对得上。
界面把 completed 显示成「待领取」（黄色）并给出「领取 N 分」按钮，claimed 显示成「已领取」。账号汇总表有「待领取 / 现在可领」两列，能直接看出还有多少分没拿。

切换本机客户端登录

在「成长计划」的任务明细节头里，对当前正在查看的那个账号提供「切换本机登录」——把本机 WorkBuddy 桌面客户端登录态改成该账号，省去手动退出重登。

客户端凭证库是明文 JSON：%LOCALAPPDATA%\CodeBuddyExtension\Data\Public\auth\workbuddy-desktop.info；账号指针在 ~/.workbuddy/storage/skeleton/account-snapshot.json
客户端自己切换账号时会把旧文件轮转成 workbuddy-desktop.<时间戳>.<pid>.<guid>.info，本仓库把这些轮转备份按 uid 归档到 data/client-login/，因此客户端登录过的账号都有原生凭证可复用
客户端 token 与管理台 token 同源（同一 Keycloak realm、azp=console、app_type=codebuddy），JWT 的 sub 即 uid，所以账号池里的 token 可直接充当客户端凭证，切换不需要重新走登录流程
破坏性操作的两道约束：① 必须显式传 confirm=true（界面有二次确认，后端再验一次）；② 切换前强制备份、备份失败即中止
目标是先解析完再备份——失败的切换不会污染上一次的有效备份（否则回滚目标会被静默换掉）
「回滚」把客户端还原到上一次切换前的登录态；备份与当前账号相同时按钮不出现（那只会是空操作）
切换后必须完全退出并重启客户端才生效
客户端运行中一律拒绝切换/回滚（接口返回 409，界面上按钮置灰并标注「客户端运行中」）。原因：登录态活在客户端内存里，我们换掉磁盘文件后它不会察觉，下一次刷 token 会把内存里的旧会话写回磁盘 —— 表现就是「切了但过一会儿自己变回去」。实测踩过：08:30 切过去， 09:40 客户端刷新时又变回来了（写回的 sessionState 与它 09-10 持有的那份完全相同）。所以检测到 WorkBuddy.exe 进程在跑就直接拒绝，而不是让用户白切一次。检测通过 tasklist 完成，结果有 3 秒缓存，避免高频轮询反复拉进程列表。

安全模型

/admin/* 与 /ui 的密钥注入只接受本机直连（loopback），非本机访问一律 403 / 401。理由：这些接口能改账号池、触发上游请求、读到账号昵称与积分。需要远程操作请走 SSH 隧道。

API Key 由服务端在渲染 /ui 时注入内联脚本（仅本机）。顶栏不显示任何 API 信息，查看与复制统一在「API 接入信息」面板。

管理台 API

端点	说明
`GET /admin/accounts`	账号视图（含 token 有效期、今日签到、凭证文件名）
`POST /admin/accounts/reload`	重扫 `auths/` 并对齐账号池
`POST /admin/accounts/{uid}/enable` · `/disable`	启用 / 禁用（禁用不动磁盘文件）
`POST /admin/accounts/{uid}/cooldown/clear`	清冷却与熔断运行态
`DELETE /admin/accounts/{uid}?purge_file=0\|1`	移出池；`purge_file=1` 才删凭证文件
`POST /admin/login/start` · `/login/poll`	OAuth 设备授权（state 内存保存，TTL 15 分钟）
`POST /admin/checkin` · `/keepalive` · `/credits/refresh`	可用 `{"uid":"..."}` 定向单账号；不传则全量（后台任务，`GET /admin/task` 查进度）
`GET /admin/travel` · `GET /admin/travel/status?uid=` · `POST /admin/travel/depart` · `/claim`	猫猫旅行；派猫/领奖会先查状态，不满足条件返回 409 并记为「跳过」而非失败
`GET /admin/growth`	成长计划快照（`?refresh=1` 强制回源）。任务明细含 `description`（达成条件）与 `how_to`（怎么做）两段说明
`POST /admin/growth/claim`	领取奖励（唯一让积分到账的动作）。`{"uid":"...","task_code":"..."}`；`task_code` 省略则领该账号全部可领任务；`uid` 省略则全量（后台任务）。已领过的记为「跳过」而非失败
`POST /admin/growth/accept` · `/redeem` · `/makeup` · `/open` · `/draw`	成长动作。不传 `uid` 即全量（后台任务）；`accept` 语义是接单（开始计进度），不发奖励，领奖走 `/claim`
`GET /admin/growth/tasks?uid=` · `GET /admin/growth/travel/config?uid=`	原始任务清单（含未达成）/ 旅行地点完整配置
`GET /admin/schedule`	查询下次唤醒与签到时点（只读；开关走 `/admin/settings`）
`POST /admin/models/refresh`	清空模型目录缓存（1h 正缓存 + 5min 负缓存）强制回源
`GET /admin/logs?since=N` · `GET /admin/logs/history?limit=N`	请求日志：内存环形缓冲 / 落盘 JSON Lines 历史
`GET /admin/stats`	调用统计聚合
`GET /admin/checkin/history?limit=N&kind=`	任务历史（保留 30 天）
`GET /admin/settings` · `PUT /admin/settings`	唯一写配置入口：读当前设置；保存即持久化（保留 config 里未知键，原子写）
`GET /admin/client-login`	本机客户端登录态 + 可切换账号（凭证来源、到期时间、是否可回滚、`client_running`）
`POST /admin/client-login/switch`	切换客户端登录态，body `{"uid":"...","confirm":true}`；未确认返回 428，客户端在跑返回 409
`POST /admin/client-login/restore`	回滚到上一次切换前的登录态，body `{"confirm":true}`；客户端在跑返回 409

新增配置项（`config.json` 的 `admin` 段，均可省略）

{
  "admin": {
    "checkin_log_path": "./data/checkin-log.json",
    "checkin_log_keep_days": 30,
    "oauth_base_url": "https://copilot.tencent.com",

    "travel_auto_claim": true,
    "travel_watch_interval_seconds": 60,

    "growth_watch_interval_seconds": 600,
    "growth_auto_claim": true,
    "growth_auto_accept_tasks": false,
    "growth_auto_makeup": true,
    "growth_auto_redeem": false,
    "growth_auto_open": false,
    "growth_auto_draw": false,

    "client_auth_dir": "",
    "client_archive_dir": "./data/client-login",
    "client_login_enabled": true
  },
  "request_log_path": "./data/request-log.jsonl",
  "request_log_keep_days": 7
}

growth_auto_claim 也接受别名 growth_auto_claim_tasks（为兼容按 growth_auto_accept_tasks 的命名习惯手写的配置）。主键优先，两者都写且冲突时以主键为准；保存设置时会把别名键收敛掉，避免文件里同时存在两个意思相同、值可能相反的键。

站点图标

internal/server/favicon.svg 自绘 SVG（蓝紫渐变圆角底板 + 对话气泡 + 四角星），//go:embed 内嵌，无外部请求。 /favicon.svg 直接返回；/favicon.ico 302 到前者以兼容旧浏览器与抓取器。

📋 请求级日志

每个 /v1/chat/completions 请求结束时输出一行表格日志（stdout）：

| #001 | 18:31:31 | deepseek-v4 | stream | 200 | uid=0851ce35 | TTFB=801ms | tok=60 | 23.5tok/s | total=2.6s |

字段	说明
`#001`	进程级请求序号
`18:31:31`	结束时刻
`deepseek-v4`	模型名（超 11 字符截断）
`stream` / `sync`	请求模式
`200`	状态码
`uid=0851ce35`	账号 UID 前 8 位
`TTFB`	流式首帧耗时（非流式为 `-`）
`tok` / `tok/s` / `total`	输出 token 数 / 速率 / 总时长

敏感度：日志不含任何 token 明文（详见安全与合规），无落盘日志文件。

🛡️ 安全与合规

1. 凭据管理（auths）

位置：./auths（auth_dir 可配），文件名 workbuddy-<uid>.json
内容：明文 accessToken / refreshToken + 账号元信息，结构见下：

{
  "account": { "uid": "…", "enterpriseId": "…", "nickname": "…" },
  "auth": { "accessToken": "明文", "refreshToken": "明文", "expiresAt": 0, "domain": "" }
}

权限：容器内以 app 用户（uid 10001）运行；token 刷新由 SaveAtomic 以 0600 原子写回（tmp + rename）；login.sh 首次落盘遵循登录 umask，建议手动 chmod 600 auths/*.json
备份：备份 auths/（凭证）与 data/state.json（池状态：积分/冷却/计数）；配置 Upstash 后状态另镜像至 Redis
切勿提交 git：.gitignore 已排除 auths/、data/、backups/、config.json、*.key、*.pem

2. 网络暴露与日志敏感度

默认监听 :7863，compose 暴露 0.0.0.0:7863，无内置 TLS；公网部署必须设置 api_key，建议前置反代/内网
请求日志字段：序号/模型/模式/状态码/uid 前 8 位/TTFB/token 数——不含 accessToken/refreshToken/api_key 明文（不读取 Authorization 头）
日志写 stdout/stderr（容器内进入 docker logs），代码无任何落盘日志文件

3. 上游访问端点清单

端点	方法	Host	用途
`/v2/chat/completions`	POST	`copilot.tencent.com`	聊天补全（SSE）
`/console/enterprises/personal/models`	GET	同上	动态模型列表
`/v2/plugin/auth/token/refresh`	POST	同上	token 刷新
`/v2/billing/meter/daily-checkin`	POST	`www.codebuddy.cn`	每日签到
`/v2/billing/meter/get-user-resource`	POST	同上	余额查询
`/v2/plugin/auth/state?platform=CLI`	POST	`copilot.tencent.com`	OAuth 取授权 URL
`/v2/plugin/auth/token?state=`	GET	同上	OAuth 轮询取 token
`/v2/plugin/login/account?state=`	GET	同上	OAuth 取账号信息
`/activity/growth/buddy/agreement` `first` `info`	POST/GET	同上	猫猫旅行：同意协议 / 首次领养 / 查询
`/activity/growth/buddy/travel/status` `depart` `claim`	GET/POST	同上	猫猫旅行：状态 / 派出 / 领奖（随签到时点执行）

上述 /v2/* 端点是 CodeBuddy 官方 CLI/插件使用的接口，未见公开 API 文档，属非公开/逆向接口；本项目不主张任何上游接口的官方授权或稳定性承诺。出站统一携带 CLI/2.63.2 CodeBuddy/2.63.2 UA；聊天请求带账号头（X-User-Id 等），永不携带 X-Refresh-Token。

4. 发布来源与合规边界

预编译产物：Release 页提供 Windows / Linux amd64 二进制包，由 GitHub Actions 在 ubuntu-latest 干净环境中用 -trimpath 构建（不含作者机器路径），并附 SHA256SUMS.txt
未经代码签名：Windows 无 Authenticode 签名（SmartScreen 会提示未知发布者）， Linux 无包管理器集成。可用 Release 附带的 SHA256 自行校验，或按 README 方式 B 自行编译
构建命令：CGO_ENABLED=0 go build -trimpath -ldflags="-s -w" -o wb2api ./cmd/server（Dockerfile 多阶段：golang:1.23-alpine 构建 → alpine:3.20 运行）
登录/签到/积分工具：./login.sh / ./signin.sh / ./credit.sh（缺失时自动编译对应 cmd/*）
无产物校验和（指 Docker 镜像）：go.sum 仅约束 Go 模块依赖；Docker 镜像由本地 docker compose build 生成，未引用第三方镜像
上游 CodeBuddy 属腾讯系商业产品，本项目是其非官方 OpenAI 兼容网关；使用其账号做 API 网关涉及目标平台服务条款与账号风险，作者不对账号封禁、条款违约或使用结果负责

5. 授权使用边界

仅限本人授权账号、本机/私有环境测试
不得共享、转售、违规分发，或用于违反目标平台条款的用途
遵守 CodeBuddy 平台服务条款与所在地法律
妥善保管 auths/（明文凭证）与网关端口

🧰 本仓库扩展（自上游的增量）

Sliverkiss/workbuddy2api 的 MIT 上游版本以网关 + 脚本为主。本仓库在保留所有上游能力的基础上追加了以下能力（详见顶部「预览」配图）：

增量	入口	价值
🖥️ 本地 WebUI 控制台	`/ui`（仅本机）	账号池 / 成长 / 旅行 / 请求日志 / 任务历史 / 设置一站式面板
🔐 管理台后端	`/admin/*`（仅本机）	改账号池、触发上游请求、读取积分
💾 请求日志缓冲	`data/request-log.jsonl`	落盘可保留 7 天；每条带 TTFB / token / tok/s
📅 签到/保活/旅行历史	`data/checkin-history.json`	30 天保留，与请求日志共用统一分页组件
🖼️ 可嵌入 favicon	`internal/server/favicon.svg`	仓库自带的渐变对话气泡 + AI 火花图标
🛠️ Windows 双击启动	`start.bat`	修正 Windows 双击 exe 时工作目录错位的问题
🛡️ CI 质量门禁	`.github/workflows/ci.yml`	PR 自动跑 go build / vet / test
📦 预编译 Release 产物	`.github/workflows/release.yml`	打 tag 自动构建 Win/Linux 二进制包并附校验和

代码上对应 internal/admin/、internal/checkinlog/、internal/logbuf/、internal/oauth/、internal/server/webui.html、start.bat、.github/、assets/。与上游同步时可只把这些目录单独合并，其余由上游更新覆盖。

🧰 工具脚本

脚本	用途
`./start.bat`	Windows：双击启动本机网关（修正工作目录，见「3b」）
`./login.sh`	OAuth 登录 → 落盘 auth → 重启容器
`./signin.sh [auths_dir]`	批量签到（过期先刷新）
`./credit.sh` / `./credit.sh -json`	积分日报（美化 / 原始 JSON）

🛠️ 开发

本地构建与测试

go build ./...
go vet ./...
go test ./... -count=20   # 多次运行验证无 flake
go test -race ./... -count=1
gofmt -l .

目录结构

cmd/
  server/    # 主服务（config + main + 路由装配）
  login/     # OAuth 登录工具
  credit/    # 积分查询工具
  signin/    # 批量签到工具
internal/
  admin/     # 管理台 /admin/*（仅本机）+ 后台任务槽          [本仓库扩展]
  auth/      # 凭证解析 + token 刷新 + 原子写回
  checkinlog/# 签到/保活/旅行历史持久化（30 天）              [本仓库扩展]
  logbuf/    # 请求日志环形缓冲 + 落盘                        [本仓库扩展]
  oauth/     # OAuth 设备授权流程（服务端侧，state 存内存）    [本仓库扩展]
  pool/      # 账号池（状态机/熔断/租约/加权/持久化）
  scheduler/ # 定时签到 + 保活 + 猫猫旅行巡检
  server/    # HTTP handler + 鉴权 + 请求日志 + 内嵌控制台（/ui、favicon）
  session/   # 会话粘性路由
  upstream/  # 上游封装（chat/billing/auth/headers/sse/payload/sanitize/idle）
  redisstore/# Upstash 持久化 + Noop 降级
assets/      # README 配图（logo.svg / architecture.svg / *.png）  [本仓库扩展]
.github/     # CI 工作流（build / vet / test + 打 tag 自动出多平台产物）  [本仓库扩展]

持续集成

.github/workflows/ci.yml 在 push / pull_request 时自动跑：

go mod tidy 后与工作区对比 —— 防止「CI 跑得过、别人 tidy 一下就改」的隐性漂移
go build ./... / go vet ./...
gofmt -l . —— 检查未格式化文件
go test ./... -count=1
go test ./... -race -count=1（advisory，见 CI 注释）

发布流程

.github/workflows/release.yml 在打 v* tag 时自动：

先跑一遍 build / vet / test —— 坏代码不该被做成产物
交叉编译 Windows amd64 与 Linux amd64（CGO_ENABLED=0 静态链接）
打包：Windows 用 .zip（含 start.bat）、Linux 用 .tar.gz
生成 SHA256SUMS.txt
上传到对应 tag 的 GitHub Release（已存在则 --clobber 覆盖）

发新版只需：

git tag -a v1.0.1 -m "v1.0.1"
git push origin v1.0.1

几十秒后 Release 页就会出现可下载的二进制包。

免责声明

本项目仅供学习和研究使用。使用者需遵守 CodeBuddy 服务条款，自行承担使用风险（包括账号封禁、条款违约等）。作者不对任何因使用本项目产生的直接或间接损失负责。

License

本项目采用 MIT License 开源协议。

允许任意使用、复制、修改、合并、发布、分发、再授权及销售
再分发（源码或二进制形式，包括内嵌编译产物的整合项目）时，请保留原仓库的 MIT 版权声明与许可声明（如在 NOTICE 或 README 中注明原始出处 https://github.com/Sliverkiss/workbuddy2api，我们将不胜感激）
本项目不授予任何上游（CodeBuddy / 腾讯）接口或服务的权利；使用者仍需自行遵守上游服务条款（见上方免责声明）

本仓库说明：本仓库是 https://github.com/Sliverkiss/workbuddy2api 的私有衍生版本，在 MIT 许可下保留上游版权声明（见 LICENSE 首行），并追加了本地管理控制台、请求日志缓冲、签到历史等扩展（详见「管理控制台」一节）。上游更新请从原仓库获取。

Name		Name	Last commit message	Last commit date
.github/workflows		.github/workflows
assets		assets
cmd		cmd
internal		internal
tests/frontend		tests/frontend
.dockerignore		.dockerignore
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
config.example.json		config.example.json
credit.sh		credit.sh
docker-compose.yml		docker-compose.yml
go.mod		go.mod
go.sum		go.sum
login.sh		login.sh
signin.sh		signin.sh
start.bat		start.bat

Latest commit

History

Folders and files

Repository files navigation