ai-battle 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +1 -139
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -16,7 +16,7 @@
16
16
  </p>
17
17
 
18
18
  <p align="center">
19
- <a href="#-中文文档">📖 中文文档</a>
19
+ <a href="README_CN.md">📖 中文文档</a>
20
20
  </p>
21
21
 
22
22
  ---
@@ -245,141 +245,3 @@ register_agent "myagent"
245
245
  ## 📄 License
246
246
 
247
247
  [MIT](LICENSE) © [Alfons](https://github.com/Alfonsxh)
248
-
249
- ---
250
-
251
- # 📖 中文文档
252
-
253
- ## ✨ 特性
254
-
255
- | 特性 | 说明 |
256
- | :--- | :--- |
257
- | 🤖 **多 Agent 圆桌** | 支持 Claude / Codex / Gemini 自由组合 |
258
- | 🔁 **同类自辩** | 同一 Agent 可参加多席位(如 `gemini,gemini`) |
259
- | 🔨 **裁判模式** | 独立裁判每轮总结差异、自动检测共识、生成最终报告 |
260
- | 👁️ **上帝视角** | 每轮结束后人工注入补充信息引导讨论方向 |
261
- | 💾 **Session 录制** | 保存 Agent CLI 原始输出(stream-json / json / raw) |
262
- | 🔄 **断点续讨** | 中断后自动恢复到上次轮次继续讨论 |
263
- | 🔌 **可扩展** | 实现 3 个函数 + 注册即可接入新 Agent |
264
-
265
- ## 🚀 快速开始
266
-
267
- ```bash
268
- # 创建讨论目录
269
- mkdir my-topic && cd my-topic
270
-
271
- # 写入问题
272
- echo "微服务 vs 单体架构的优缺点?" > problem.md
273
-
274
- # 启动讨论(自动拉取最新版)
275
- npx ai-battle --agents claude,gemini --rounds 8
276
- ```
277
-
278
- ## 📦 安装
279
-
280
- **推荐:无需安装,直接使用 npx**
281
-
282
- ```bash
283
- npx ai-battle --agents claude,gemini --rounds 5
284
- ```
285
-
286
- > npx 每次执行自动拉取最新版本,无需手动更新。
287
-
288
- **全局安装:**
289
-
290
- ```bash
291
- npm install -g ai-battle
292
- ```
293
-
294
- ### 前置依赖
295
-
296
- - `bash` 4+
297
- - [`jq`](https://jqlang.github.io/jq/)
298
- - Agent CLI 工具(至少安装 2 个):`claude` / `codex` / `gemini`
299
-
300
- ## 📖 用法
301
-
302
- ```
303
- ai-battle [options]
304
- ai-battle help
305
- ```
306
-
307
- | 参数 | 说明 | 默认值 |
308
- | :--- | :--- | :--- |
309
- | `--agents, -a <a1,a2>` | 选择参与的 Agent,支持同类 | `claude,codex` |
310
- | `--rounds, -r <N>` | 最大讨论轮次 | `10` |
311
- | `--god, -g` | 开启上帝视角(每轮可注入补充信息) | — |
312
- | `--referee [agent]` | 开启裁判模式(每轮总结 + 生成 SUMMARY.md) | — |
313
-
314
- ### 💡 示例
315
-
316
- ```bash
317
- # 同类 Agent 自我辩论
318
- ai-battle --agents gemini,gemini
319
-
320
- # 三方圆桌讨论
321
- ai-battle --agents claude,codex,gemini --rounds 5
322
-
323
- # 裁判模式
324
- ai-battle --agents claude,codex,gemini --referee --rounds 5
325
-
326
- # 指定 claude 做裁判
327
- ai-battle --agents codex,gemini --referee claude --rounds 5
328
-
329
- # 上帝视角 + 裁判
330
- ai-battle --agents claude,codex --referee --god
331
- ```
332
-
333
- ## 📁 产出结构
334
-
335
- ```text
336
- my-topic/
337
- ├── problem.md # 讨论问题(用户创建)
338
- ├── referee.md # 裁判自定义提示词(可选)
339
- ├── SUMMARY.md # 最终总结(裁判自动生成)
340
- ├── .env # 环境变量(启动时自动加载)
341
- └── .ai-battle/ # 所有运行时产物
342
- ├── rounds/ # 讨论轮次记录
343
- │ ├── round_1_claude.md
344
- │ ├── round_1_gemini.md
345
- │ ├── referee_round_2.md # 裁判总结(--referee)
346
- │ └── god_round_1.md # 上帝注入(--god)
347
- ├── sessions/ # Agent CLI 原始输出
348
- ├── agents/ # Agent 指令文件
349
- ├── consensus.md # 共识结论(如达成)
350
- ├── config.json # 会话配置
351
- └── battle.log # 运行日志(tail -f 实时查看)
352
- ```
353
-
354
- ## 🔌 扩展 Agent
355
-
356
- 只需实现 3 个函数并注册:
357
-
358
- ```bash
359
- # 1. 实现函数
360
- check_myagent() { ... } # 可用性检查,返回 0/1
361
- call_myagent() { ... } # 调用 Agent: $1=system_prompt $2=user_msg $3=session_tag
362
- generate_myagent_md() { ... } # 生成指令文件: $1=max_rounds $2=problem
363
-
364
- # 2. 注册
365
- register_agent "myagent"
366
- ```
367
-
368
- ## 🔑 环境变量
369
-
370
- | 变量 | 说明 | 默认值 |
371
- | :--- | :--- | :--- |
372
- | `ANTHROPIC_BASE_URL` | Claude API 地址 | — |
373
- | `ANTHROPIC_AUTH_TOKEN` | Claude 认证 Token | — |
374
- | `ANTHROPIC_DEFAULT_SONNET_MODEL` | Claude 模型名称 | — |
375
- | `API_TIMEOUT_MS` | Claude 超时时间(毫秒) | — |
376
- | `CODEX_MODEL` | Codex 模型名称 | `gpt-5.3-codex` |
377
- | `GEMINI_API_KEY` | Gemini API Key | — |
378
-
379
- ## 🤝 参与贡献
380
-
381
- 欢迎提交 [Issue](https://github.com/Alfonsxh/ai-battle/issues) 和 [Pull Request](https://github.com/Alfonsxh/ai-battle/pulls)!
382
-
383
- ## 📄 许可
384
-
385
- [MIT](LICENSE) © [Alfons](https://github.com/Alfonsxh)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ai-battle",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "description": "让多个 AI Agent 对同一问题进行结构化圆桌讨论",
5
5
  "bin": {
6
6
  "ai-battle": "./ai-battle.sh"