# tierflowmore

**Repository Path**: opencode-plugin/tierflowmore

## Basic Information

- **Project Name**: tierflowmore
- **Description**: tierflowmore - 支持多key轮询 (清枢智汇)
- **Primary Language**: TypeScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-22
- **Last Updated**: 2026-10-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# TierFlow More OpenCode Provider Plugin

**提供商 ID**: `tierflowmore` | **显示名称**: TierFlow More | **Base URL**: `https://tierflow.cn/v1`

OpenCode 插件，集成 TierFlow（tierflow.cn）API 网关，单提供商多 API Key 轮询以缓解速率限制，适配 `@ai-sdk/openai-compatible`（Chat Completions）协议。

## 功能

- **多 Key 轮询** — 输入多个 API Key（逗号分隔），自动循环切换，减缓 `429` 速率限制
- **错误容错** — 单个 Key 连续错误 3 次自动跳过，全部不可用时重置计数
- **模型支持** — 内置 5 个模型（Qwen3.8-Flash / GLM-5.3-FlashX / GLM-5.3-Flash / GLM-5.3 / DeepSeek-V4.1-Flash），最大 1.3M 上下文
- **思考内容分离** — 声明 `interleaved` 后 OpenCode 渲染独立思考区；插件注入 `thinking` 开关兜底
- **模型别名映射** — 上游模型 id 大小写敏感（如 `Qwen3.8-Flash`），OpenCode 上送全小写别名，插件改写后请求
- **短暂错误重试** — 上游 5xx 与网络异常统一返回 429/502 错误流，交由 OpenCode 重试
- **未授权兜底** — 未配置 Key 时直接返回 401 并提示授权，不触发无意义重试
- **调试日志** — `~/.tierflowmore/debug.log`，由环境变量控制开关
- **凭证存储** — API Key 持久化到 `~/.tierflowmore/auth.json`

## 安装

### 前提

- Node.js 22+
- OpenCode

### 步骤

```bash
# 1. 进入项目
cd tierflowmore

# 2. 安装依赖
npm install

# 3. 构建
npm run build
```

## 配置

### 1. 配置 opencode.json

```json
{
  "plugins": [
    "/path/to/tierflowmore"
  ]
}
```

### 2. 添加凭据

在 OpenCode 中执行 `/connect` 命令，选择 **TierFlow More**：

```
┌ 创建apiKey：https://tierflow.cn/keys
│ 注册赠送￥30额度，使用以下邀请链接 额外获得 ￥5 额度：
│ https://tierflow.cn/register?referral_code=aWvHGfdZ5ssS
│ https://tierflow.cn/register?referral_code=Mjn3O5rYwE75
│ https://tierflow.cn/register?referral_code=uLi0pjjvPrLR
│
│ 输入 API Keys（多key用逗号分隔）
│ ────────────────────────────────
│ sk-key1,sk-key2,sk-key3
└ enter
```

> 多个 Key 用逗号分隔，插件会自动轮询使用。未授权时模型请求会返回
> `未授权：请通过 /connect 命令点击 TierFlow More 进行授权`。

### 3. 选择模型

执行 `/models` 命令，选择可用模型：

| Model ID | 上游模型 | 描述 | 上下文 | 最大输出 |
|----------|----------|------|--------|----------|
| `qwen3.8-flash` | `Qwen3.8-Flash` | Qwen3.8 Flash | 1M | 128K |
| `glm-5.3-flashx` | `GLM-5.3-FlashX` | GLM 5.3 FlashX | 1M | 128K |
| `glm-5.3-flash` | `GLM-5.3-Flash` | GLM 5.3 Flash | 1.3M | 128K |
| `glm-5.3` | `GLM-5.3` | GLM 5.3 | 1.3M | 128K |
| `deepseek-v4.1-flash` | `DeepSeek-V4.1-Flash` | DeepSeek V4.1 Flash | 1M | 384K |

> 所有模型 `cost` 均为 `{ input: 0, output: 0 }`（插件不计费，实际消耗以 TierFlow 平台额度为准）。

> **模型别名映射**：OpenCode 上送的是表中 `Model ID` 列（全小写别名），插件通过它匹配
> `constants.ts` 中的模型定义，再用「上游模型」列的真实 id 请求上游。
> 上游模型 id **大小写敏感** —— 传小写 id 可能返回 400/404，因此改写是必需的。

## 思考内容处理

推理模型声明 `reasoning: true` + `interleaved: { field: 'reasoning_content' }`，
OpenCode 通过 `reasoning_content` 字段渲染为独立思考区。

插件额外在请求体注入 `thinking: { type: "enabled" }` 作为开关兜底
（防止上游偶发把推理混入 `content`）。`reasoning_effort` 由 OpenCode 按用户选择的
档位自动传入（SDK 在 `transformRequestBody` 之前写入），插件仅透传、不写死。

## 多 Key 轮询机制

```
请求 → 自定义 fetch → KeyManager.getNextKey()
                        ↓
                 ┌──────────────┐
                 │  key1  ← 首次 │
                 │  key2  ← 下次 │
                 │  key3  ← 再下次 │
                 └──────────────┘
                        ↓
                 写入 Authorization → 发起 API 请求
```

- 循环轮询：`key1 → key2 → key3 → key1 → ...`
- 错误追踪：每个 Key 连续失败 3 次后跳过
- 自动恢复：所有 Key 都被跳过时重置计数
- 成功自愈：请求成功后清零该 Key 的错误计数

## 错误处理

自定义 `fetch` 统一将上游错误转换为 OpenCode 可解析的标准 JSON 错误流：

| 场景 | 行为 |
|------|------|
| 401 / 403 | 原样返回上游 Response；`isRetryable=false` 立即报错（不重试），保留上游原始错误消息 |
| 429 | 原样返回上游 Response；由 OpenCode 判断重试 |
| 5xx / 网络异常 | 返回 429 / 502 标准错误流，触发 OpenCode 重试 |
| 400 / 404 等非瞬态错误 | 保留原状态码立即报错（参数校验错误，重试无意义） |
| 408 / 409 | 返回原状态码，OpenCode 视为可重试 |
| 未授权（无 Key） | 返回 401 并提示 `/connect` 授权，不发真实请求 |

## 调试日志

通过环境变量开启调试日志：

```bash
# 方式一：全局 DEBUG
DEBUG=1 opencode

# 方式二：仅 TierFlow More
OPENCODE_TIERFLOWMORE_DEBUG=1 opencode
```

日志位置：`%USERPROFILE%\.tierflowmore\debug.log`

> 环境变量在**插件加载时**读取，需在启动 OpenCode 前设置。

### 日志格式

可读 TEXT 单行格式，按 append 追加：

```
[2026-09-22T08:25:05.573Z] [INFO ] Auth loader initialized  {"keyCount":3,"keys":["1:sk-8K0B...32fn","2:sk-...","3:sk-..."]}
[2026-09-22T08:25:05.595Z] [INFO ] Request start  {"seq":1,"key":"sk-8K0B...32fn","keyPos":"1/3","model":"Qwen3.8-Flash","endpoint":"/v1/chat/completions"}
[2026-09-22T08:25:09.864Z] [INFO ] Request success  {"seq":1,"key":"sk-8K0B...32fn","keyPos":"1/3","status":200,"stream":true,"ms":4046}
```

### 确认 Key 轮询情况

**每个请求（无论成功或失败）都会记录所用 key**，用于确认轮询是否生效：

| 字段 | 含义 |
|------|------|
| `seq` | 请求序号（插件生命周期内自增） |
| `key` | 该请求实际使用的 API Key（掩码，保留前 8 位 + 末 4 位） |
| `keyPos` | 该 key 在池中的位置，如 `2/3` |
| `model` | 请求的模型（已改写为上游真实 id） |
| `endpoint` | 请求路径，如 `/v1/chat/completions` |
| `status` / `stream` / `ms` | 响应状态码 / 是否流式 / 耗时毫秒 |

观察 `seq` 与 `keyPos` 的对应关系即可确认轮询：

```
seq:1 keyPos:1/3   seq:2 keyPos:2/3   seq:3 keyPos:3/3
seq:4 keyPos:1/3   ← 3 把 key 用完一轮后回到第 1 把
```

相关事件：

| 事件 | 级别 | 说明 |
|------|------|------|
| `Provider config updated` | INFO | config 钩子注册 provider 与模型 |
| `Auth loader initialized` | INFO | 载入 key 池，列出全部掩码 key 及序号 |
| `Request start` | INFO | 请求发出前（含 key / keyPos / model） |
| `Request success` | INFO | 请求成功（含状态码 / 是否流式 / 耗时） |
| `Upstream error response` | WARN | 上游返回错误（含状态码 / 原始消息） |
| `Key error count increased` | WARN | key 连续失败计数（≥3 次将被跳过） |
| `Key recovered, error count reset` | INFO | 成功请求后清零该 key 错误计数 |
| `Unauthenticated request blocked` | WARN | 未授权兜底拦截 |
| `Fetch network error` | ERROR | 网络异常 |
| `SSE chunk` | DEBUG | 流式响应逐块内容 |

## 项目结构

```
tierflowmore/
├── package.json
├── tsconfig.json
├── src/
│   ├── index.ts              # 主入口：auth hook + config hook + 共享 fetch + SSE 拦截
│   ├── constants.ts          # 提供商配置、模型定义
│   ├── plugin/
│   │   ├── auth.ts           # 凭证读写 ~/.tierflowmore/auth.json
│   │   └── key-manager.ts    # 多 Key 轮询算法
│   └── utils/
│       └── debug-logger.ts   # 文件日志（无 console.error）
└── dist/                     # 构建产物
```

## 开发

```bash
npm run typecheck   # 类型检查
npm run build       # 构建到 dist/
```
## Key 黑名单（blacklist.json）

KeyManager 会为每个 Key 维护错误计数，持久性错误（`401/403/400` 等）触发 `reportError`（计数 +1），
当 `errorCount >= 3` 时该 Key 被临时拉黑，轮询时自动跳过；请求成功一次即触发 `reportSuccess` 复位计数。
黑名单状态通过快照文件跨重启保留，重启后自动恢复各 Key 的错误计数。

快照文件格式（与插件写盘格式一致）：

```json
{
  "updatedAt": 1759800000000,
  "keys": [
    { "key": "sk-xxx1", "errorCount": 3, "blocked": true },
    { "key": "sk-xxx2", "errorCount": 0, "blocked": false }
  ]
}
```

目标路径：`%USERPROFILE%\.tierflowmore\blacklist.json`

复制方法（可选）：将项目 `jsonc/blacklist.jsonc` 复制到 `%USERPROFILE%\.tierflowmore\` 并重命名为
`blacklist.json`。不复制也不影响运行——插件仅在内存中计数，不跨重启保留；快照读写失败仅记录
debug 警告，绝不中断主流程。

## 配置文件

插件运行所需的配置文件位于本仓库 ./jsonc/ 目录下（provider.jsonc 与 models.jsonc）。使用前将这两个文件复制到用户目录 %USERPROFILE%\.tierflowmore/ 下（缺失时插件启动会 fail fast 报错）。复制后可按需编辑模型列表与提供商信息（支持注释），修改后重启插件生效。