# gpt-auto

一个用于**账号池维护（清理 + 补号）**的本地工具，包含：

- Python 后端（`api_server.py` + `auto_pool_maintainer.py`）
- Preact 前端控制台（`frontend/`）
- 一键启动脚本（`dev_services.sh`）

---

## 新手快速上手（最短路径）

> 目标：第一次就能正确拉起项目并进入前端面板。

### 1) 安装依赖

在项目根目录执行：

```bash
# 1. Python 依赖（推荐使用 uv）
uv venv .venv
uv pip install -r requirements.txt

# 如果你不使用 uv，也可以继续用 venv + pip
# python3 -m venv .venv
# ./.venv/bin/pip install -r requirements.txt

# 2. 前端依赖
cd frontend
pnpm install
cd ..
```

说明：

- `uv` 这里只用于安装 Python 后端依赖；前端依赖仍然使用 `pnpm`
- 当前仓库没有 `pyproject.toml` / `uv.lock`，因此这里使用 `uv pip install -r requirements.txt`，而不是 `uv sync`
- `uv venv .venv` 创建的虚拟环境与现有启动脚本兼容，无需额外修改脚本

### 2) 准备配置文件

```bash
cp config.example.json config.json
```

然后至少修改以下关键项（不改会跑不起来）：

- `clean.base_url`：你的 CLIProxyAPI 地址（例如 `http://127.0.0.1:8317`）
- `clean.token`：CLIProxyAPI 管理 token
- `mail.provider` + 对应 provider 的配置（`mail.api_base/api_key/domain` 等）

### 3) 启动项目

```bash
# macOS / Linux
./dev_services.sh fg

# Windows PowerShell
.\dev_services.ps1 fg
```

启动成功后：

- 前端地址：`http://127.0.0.1:8173`
- 后端 API：`http://127.0.0.1:8318`

首次启动后端会生成 `admin_token.txt`，把里面的 token 复制到前端登录框（`X-Admin-Token`）。

---

## 关键配置说明（只讲重要的）

配置文件：`config.json`

### `clean`（账号探测/清理）

- `base_url` / `token`：CLIProxyAPI 连接信息（必填）
- `target_type`：目标账号类型（通常为 `codex`）
- `used_percent_threshold`：超阈值判定

### `maintainer`（补号目标）

- `min_candidates`：目标可用号数量（低于它就补号）
- `loop_interval_seconds`：循环模式下每轮检查间隔

### `run`（补号执行参数）

- `workers`：补号并发
- `failure_threshold_for_cooldown` / `failure_cooldown_seconds`：连续失败冷却策略

### `mail`（邮箱提供方）

- `provider`：`self_hosted_mail_api / duckmail / tempmail_lol / yyds_mail`
- 不同 provider 需要填写对应 section 的鉴权字段
- `otp_timeout_seconds` / `poll_interval_seconds`：验证码等待与轮询间隔

---

## 常用命令

```bash
# win 用户可用 dev_services.ps1 脚本启动
# 下方示例默认使用 bash 写法，Windows 对应命令见后

# macOS / Linux

# 前台启动（推荐调试）
./dev_services.sh fg

# 后台启动
./dev_services.sh bg

# 查看状态
./dev_services.sh status

# 停止后台服务
./dev_services.sh stop
```

Windows PowerShell 对应命令：

```powershell
# 前台启动（推荐调试）
.\dev_services.ps1 fg

# 后台启动
.\dev_services.ps1 bg

# 查看状态
.\dev_services.ps1 status

# 停止后台服务
.\dev_services.ps1 stop
```

单次执行维护任务（不走前端）：

```bash
# macOS / Linux
./.venv/bin/python auto_pool_maintainer.py --config config.json --log-dir logs

# Windows PowerShell
.\.venv\Scripts\python.exe auto_pool_maintainer.py --config config.json --log-dir logs
```

---

## 日志与产物

- 维护日志：`logs/pool_maintainer_*.log`
- 服务托管日志：`logs/dev-services/`
- 本地 token/账号输出（当 `output.save_local=true` 时）：
  - `output_fixed/`
  - `output_tokens/`

---

## 排错建议（高频）

1. 前端打开但接口 401：通常是 `X-Admin-Token` 错误，重新读取 `admin_token.txt`
2. 补号不触发：先看日志里的 `清理后统计: candidates=... 阈值=...`
3. 启动失败：先看 `logs/dev-services/backend.log` / `frontend.log`
4. OAuth 偶发慢：优先看日志中的 `oauth_mail_otp_timeout` 是否增多（邮箱链路波动）
5. 持久化bug 若出现卡住无法stop,把持久化文件`.maintainer_run_state.json`删掉即可
---

## 安全提示

- `config.json`、`admin_token.txt` 可能包含敏感信息，不要公开上传。
- 对外发布代码时，建议仅保留 `config.example.json`。