@xinshu/openagi 0.0.1 → 0.0.2-dev.0

package/README.md

@@ -1,60 +1,424 @@
-# OpenAGI (@anthropic-ai/claude-code style)
+# OpenAGI - AI Coding
 
-This is a self-contained distribution of OpenAGI, packaged in the style of @anthropic-ai/claude-code.
+<div align="center">
+  <img src="./logo.svg" alt="OpenAGI Logo" width="400" />
+</div>
 
-## Structure
+## 🎯 项目介绍
 
-This distribution follows the same structure as @anthropic-ai/claude-code:
+OpenAGI 是开源 AI 编程助手。采用 TypeScript + React + Ink 现代化架构，提供强大的 AI 辅助编程能力，支持文件操作、系统交互、智能搜索等丰富功能。
+
+<img width="90%" alt="image" src="https://github.com/user-attachments/assets/fdce7017-8095-429d-b74e-07f43a6919e1" />
+
+<img width="90%" alt="2c0ad8540f2872d197c7b17ae23d74f5" src="https://github.com/user-attachments/assets/f220cc27-084d-468e-a3f4-d5bc44d84fac" />
+
+<img width="90%" alt="f266d316d90ddd0db5a3d640c1126930" src="https://github.com/user-attachments/assets/90ec7399-1349-4607-b689-96613b3dc3e2" />
+
+
+<img width="90%" alt="image" src="https://github.com/user-attachments/assets/b30696ce-5ab1-40a0-b741-c7ef3945dba0" />
+
+
+## 📢 更新日志
+
+**2025-08-29**：我们已添加 Windows 支持！所有 Windows 用户现在可以在他们的计算机上使用 Git Bash、Unix 子系统或 WSL（Windows 子系统 for Linux）运行 OpenAGI。
+
+
+## 🤝 AGENTS.md 标准支持
+
+**OpenAGI 骄傲地支持由 OpenAI 发起的 [AGENTS.md 标准协议](https://agents.md)** - 一种用于指导编程代理的简单、开放格式，已被 20k+ 开源项目使用。
+
+### 与多种标准的完全兼容
+
+- ✅ **AGENTS.md** - 原生支持 OpenAI 发起的标准格式
+- ✅ **CLAUDE.md** - 与 Claude Code 的 `.claude` 配置完全向后兼容
+- ✅ **子代理系统** - 高级代理委派和任务编排
+- ✅ **跨平台** - 可与 20+ AI 模型和提供商配合使用
+
+使用 `# 您的文档请求` 自动生成和维护您的 AGENTS.md 文件，同时保持与现有 `.claude` 工作流的兼容性。
+
+## 概述
+
+OpenAGI 是一个强大的 AI 助手，驻留在您的终端中。它可以理解您的代码库、编辑文件、运行命令并为您处理整个工作流程。
+
+> **⚠️ 安全提示**：OpenAGI 默认以 YOLO 模式运行（相当于 Claude Code 的 `--dangerously-skip-permissions` 标志），绕过所有权限检查以实现最大生产力。YOLO 模式仅建议在受信任的安全环境中处理非关键项目时使用。如果您正在处理重要文件或使用能力存疑的模型，我们强烈建议使用 `openagi --safe` 启用权限检查和所有操作的手动批准。
+>
+> **📊 模型性能**：为了获得最佳性能，我们建议使用专为自主任务完成设计的更新、更强大的模型。避免使用像 GPT-4o 或 Gemini 2.5 Pro 这样的旧版问答优化模型，它们针对回答问题而非持续独立任务执行进行了优化。应选择专门为代理工作流程和扩展推理能力训练的模型。
+
+<img width="600" height="577" alt="image" src="https://github.com/user-attachments/assets/8b46a39d-1ab6-4669-9391-14ccc6c5234c" />
+
+## 功能特性
+
+### 核心能力
+- 🤖 **AI 驱动助手** - 使用先进的 AI 模型理解和响应您的请求
+- 🔄 **多模型协作** - 灵活切换和组合多个 AI 模型以利用它们的独特优势
+- 🦜 **专家模型咨询** - 使用 `@ask-model-name` 咨询特定 AI 模型以获得专业分析
+- 👤 **智能代理系统** - 使用 `@run-agent-name` 将任务委派给专业子代理
+- 📝 **代码编辑** - 通过智能建议和改进直接编辑文件
+- 🔍 **代码库理解** - 分析您的项目结构和代码关系
+- 🚀 **命令执行** - 运行 shell 命令并实时查看结果
+- 🛠️ **工作流程自动化** - 通过简单的提示处理复杂的开发任务
+
+### 编辑舒适度
+- `Ctrl+G` 在您偏好的编辑器中打开消息（尊重 `$EDITOR`/`$VISUAL`；回退到 code/nano/vim/notepad），并在关闭时将文本返回到提示符。
+- `Shift+Enter` 在提示符内插入换行符而不发送；直接 Enter 提交。`Ctrl+M` 切换活动模型。
+
+### 🎯 先进的智能补全系统
+我们的最先进补全系统提供无与伦比的编码辅助：
+
+#### 智能模糊匹配
+- **连字符感知匹配** - 输入 `dao` 即可匹配 `run-agent-dao-qi-harmony-designer`
+- **缩写支持** - `dq` 匹配 `dao-qi`，`nde` 匹配 `node`
+- **数字后缀处理** - `py3` 智能匹配 `python3`
+- **多算法融合** - 结合 7+ 种匹配算法以获得最佳结果
+
+#### 智能上下文检测
+- **无需 @ 符号** - 直接输入 `gp5` 即可匹配 `@ask-gpt-5`
+- **自动前缀添加** - Tab/Enter 自动为代理和模型添加 `@`
+- **混合补全** - 在命令、文件、代理和模型之间无缝切换
+- **智能优先级** - 根据相关性和使用频率对结果进行排名
+
+#### Unix 命令优化
+- **500+ 常用命令** - 精心策划的常用 Unix/Linux 命令数据库
+- **系统交集** - 仅显示您的系统上实际存在的命令
+- **优先级评分** - 常用命令排在前面（git、npm、docker 等）
+- **实时加载** - 从系统 PATH 动态发现命令
+
+### 用户体验
+- 🎨 **交互式 UI** - 具有语法高亮的精美终端界面
+- 🔌 **工具系统** - 可扩展架构，针对不同任务提供专业工具
+- 💾 **上下文管理** - 智能上下文处理以保持对话连续性
+- 📋 **AGENTS.md 集成** - 使用 `# 文档请求` 自动生成和维护项目文档
+
+## 安装
+
+```bash
+npm install -g @xinshu/openagi
+```
+
+安装后，您可以使用以下任何命令：
+- `openagi` - 主命令
+- `agi` - OpenAGI With Agent（替代命令）
+
+### Windows 说明
+
+- 安装 Git for Windows 以提供 Bash（类似 Unix）环境：https://git-scm.com/download/win
+  - OpenAGI 在可用时自动优先使用 Git Bash/MSYS 或 WSL Bash。
+  - 如果两者都不可用，它将回退到您的默认 shell，但许多功能在 Bash 下效果最佳。
+- 使用 VS Code 的集成终端而不是旧版命令提示符（cmd）：
+  - 更好的字体渲染和图标支持。
+  - 与 cmd 相比，路径和编码的怪癖更少。
+  - 尽可能选择"Git Bash"作为 VS Code 终端 shell。
+- 可选：如果您通过 npm 全局安装，请避免全局前缀路径中的空格以防止 shim 问题。
+  - 示例：`npm config set prefix "C:\\npm"` 并重新安装全局包。
+
+## 使用方法
+
+### 交互式模式
+启动交互式会话：
+```bash
+openagi
+# 或
+agi
 
 ```
-openagi-anthropic-style/
-├── cli.js                  # Main CLI executable (self-contained bundle)
-├── cli.mjs                 # ES module version
-├── package.json            # Package configuration
-├── sdk.d.ts               # TypeScript definitions for SDK
-├── sdk-tools.d.ts         # TypeScript definitions for tools
-├── sdk.mjs                # SDK ES module
-├── LICENSE.md             # License information
-├── README.md              # This file
-├── node_modules/          # Optional dependencies structure
-│   └── @img/              # Sharp platform-specific binaries
-└── vendor/                # Binary tools and utilities
-    └── ripgrep            # Ripgrep binary
+
+### 非交互式模式
+快速获取响应：
+```bash
+openagi -p "解释这个函数" path/to/file.js
+# 或
+agi -p "解释这个函数" path/to/file.js
+```
+
+### 使用 @ 提及系统
+
+OpenAGI 支持强大的 @ 提及系统以实现智能补全：
+
+#### 🦜 专家模型咨询
+```bash
+# 咨询特定 AI 模型以获得专家意见
+@ask-claude-sonnet-4 我应该如何优化这个 React 组件的性能？
+@ask-gpt-5 这种身份验证方法的安全影响是什么？
+@ask-o1-preview 分析这个算法的复杂性
 ```
 
-## Usage
+#### 👤 专业代理委派
+```bash
+# 将任务委派给专业子代理
+@run-agent-simplicity-auditor 审查这段代码是否存在过度工程化
+@run-agent-architect 为这个系统设计微服务架构
+@run-agent-test-writer 为这些模块创建全面的测试
+```
 
+#### 📁 智能文件引用
 ```bash
-# Make executable (if needed)
-chmod +x cli.js
+# 使用自动补全引用文件和目录
+@src/components/Button.tsx
+@docs/api-reference.md
+@.env.example
+```
 
-# Run OpenAGI directly
-./cli.js --help
+@ 提及系统在您输入时提供智能补全，显示可用的模型、代理和文件。
+
+### AGENTS.md 文档模式
 
-# Or via node
-node cli.js --help
+使用 `#` 前缀生成和维护您的 AGENTS.md 文档：
+
+```bash
+# 生成设置说明
+# 我如何设置开发环境？
+
+# 创建测试文档
+# 这个项目的测试程序是什么？
+
+# 记录部署过程
+# 解释部署管道和要求
+```
+
+此模式自动将响应格式化为结构化文档，并将它们附加到您的 AGENTS.md 文件中。
+
+### Docker 使用
+
+#### 替代方案：从本地源构建
+
+```bash
+# 克隆仓库
+git clone https://github.com/xingshuzhice/openagi.git
+cd openagi
+
+# 在本地构建镜像
+docker build --no-cache -t openagi .
+
+# 在您的项目目录中运行
+cd your-project
+docker run -it --rm \
+  -v $(pwd):/workspace \
+  -v ~/.openagi:/root/.openagi \
+  -v ~/.openagi.json:/root/.openagi.json \
+  -w /workspace \
+  openagi
 ```
 
-## Installation
+#### Docker 配置详情
+
+Docker 设置包括：
+
+- **卷挂载**：
+  - `$(pwd):/workspace` - 挂载您当前的项目目录
+  - `~/.openagi:/root/.openagi` - 在运行之间保留您的 openagi 配置目录
+  - `~/.openagi.json:/root/.openagi.json` - 在运行之间保留您的 openagi 全局配置文件
+
+- **工作目录**：在容器内设置为 `/workspace`
+
+- **交互模式**：使用 `-it` 标志进行交互式终端访问
+
+- **清理**：`--rm` 标志在退出后删除容器
+
+**注意**：OpenAGI 同时使用 `~/.openagi` 目录存储额外数据（如内存文件）和 `~/.openagi.json` 文件进行全局配置。
+
+第一次运行 Docker 命令时，它将构建镜像。后续运行将使用缓存镜像以加快启动速度。
+
+您可以使用入门来设置模型，或使用 `/model`。
+如果您在列表中看不到想要的模型，可以在 `/config` 中手动设置
+只要您有类似 openai 的端点，它就应该工作。
+
+### 命令
+
+- `/help` - 显示可用命令
+- `/model` - 更改 AI 模型设置
+- `/config` - 打开配置面板
+- `/cost` - 显示令牌使用情况和成本
+- `/clear` - 清除对话历史
+- `/init` - 初始化项目上下文
+
+## 多模型智能协作
+
+与只支持单一模型的官方 Claude 不同，OpenAGI 实现了**真正的多模型协作**，让您充分利用不同 AI 模型的独特优势。
+
+### 🏗️ 核心技术架构
+
+#### 1. **ModelManager 多模型管理器**
+我们设计了统一的 `ModelManager` 系统，支持：
+- **模型配置文件**：每个模型都有独立的配置文件，包含 API 端点、身份验证、上下文窗口大小、成本参数等。
+- **模型指针**：用户可以在 `/model` 命令中为不同目的配置默认模型：
+  - `main`：主代理的默认模型
+  - `task`：子代理的默认模型
+  - `reasoning`：保留供将来 ThinkTool 使用
+  - `quick`：用于简单 NLP 任务的快速模型（安全识别、标题生成等）
+- **动态模型切换**：支持运行时模型切换，无需重启会话，保持上下文连续性
+
+#### 2. **TaskTool 智能任务分配**
+我们专门设计的 `TaskTool`（架构师工具）实现了：
+- **子代理机制**：可以启动多个子代理并行处理任务
+- **模型参数传递**：用户可以在请求中指定子代理应使用哪个模型
+- **默认模型配置**：子代理默认使用 `task` 指针配置的模型
+
+#### 3. **AskExpertModel 专家咨询工具**
+我们专门设计了 `AskExpertModel` 工具：
+- **专家模型调用**：允许在对话期间临时调用特定专家模型解决难题
+- **模型隔离执行**：专家模型响应独立处理，不影响主对话流程
+- **知识整合**：将专家模型见解整合到当前任务中
+
+#### 🎯 灵活的模型切换
+- **Tab 键快速切换**：在输入框中按 Tab 键快速切换当前对话的模型
+- **`/model` 命令**：使用 `/model` 命令配置和管理多个模型配置文件，为不同目的设置默认模型
+- **用户控制**：用户可以随时指定特定模型进行任务处理
+
+#### 🔄 智能工作分配策略
+
+**架构设计阶段**
+- 使用 **o3 模型** 或 **GPT-5 模型** 探索系统架构并制定清晰明确的技术方案
+- 这些模型在抽象思维和系统设计方面表现出色
+
+**方案细化阶段**
+- 使用 **gemini 模型** 深入探索生产环境设计细节
+- 利用其在实际工程和平衡推理方面的深厚积累
+
+**代码实现阶段**
+- 使用 **Qwen Coder 模型**、**Kimi k2 模型**、**GLM-4.5 模型** 或 **Claude Sonnet 4 模型** 进行具体代码编写
+- 这些模型在代码生成、文件编辑和工程实现方面表现强劲
+- 支持通过子代理并行处理多个编码任务
+
+**问题解决**
+- 遇到复杂问题时，咨询 **o3 模型**、**Claude Opus 4.1 模型** 或 **Grok 4 模型** 等专家模型
+- 获得深入的技术见解和创新解决方案
+
+#### 💡 实际应用场景
+
+```bash
+# 示例 1：架构设计
+"使用 o3 模型帮我设计一个高并发消息队列系统架构"
+
+# 示例 2：多模型协作
+"首先使用 GPT-5 模型分析这个性能问题的根本原因，然后使用 Claude Sonnet 4 模型编写优化代码"
+
+# 示例 3：并行任务处理
+"使用 Qwen Coder 模型作为子代理同时重构这三个模块"
+
+# 示例 4：专家咨询
+"这个内存泄漏问题很棘手，单独询问 Claude Opus 4.1 模型寻求解决方案"
+
+# 示例 5：代码审查
+"让 Kimi k2 模型审查这个 PR 的代码质量"
+
+# 示例 6：复杂推理
+"使用 Grok 4 模型帮我推导这个算法的时间复杂度"
+
+# 示例 7：方案设计
+"让 GLM-4.5 模型设计一个微服务分解方案"
+```
+
+### 🛠️ 关键实现机制
+
+#### **配置系统**
+```typescript
+// 多模型配置支持示例
+{
+  "modelProfiles": {
+    "o3": { "provider": "openai", "model": "o3", "apiKey": "..." },
+    "claude4": { "provider": "anthropic", "model": "claude-sonnet-4", "apiKey": "..." },
+    "qwen": { "provider": "alibaba", "model": "qwen-coder", "apiKey": "..." }
+  },
+  "modelPointers": {
+    "main": "claude4",      // 主对话模型
+    "task": "qwen",         // 任务执行模型
+    "reasoning": "o3",      // 推理模型
+    "quick": "glm-4.5"      // 快速响应模型
+  }
+}
+```
+
+#### **成本跟踪系统**
+- **使用统计**：使用 `/cost` 命令查看每个模型的令牌使用情况和成本
+- **多模型成本比较**：实时跟踪不同模型的使用成本
+- **历史记录**：保存每个会话的成本数据
+
+#### **上下文管理器**
+- **上下文继承**：切换模型时保持对话连续性
+- **上下文窗口适应**：根据不同模型的上下文窗口大小自动调整
+- **会话状态保持**：确保多模型协作期间的信息一致性
+
+### 🚀 多模型协作的优势
+
+1. **最大化效率**：每个任务由最合适的模型处理
+2. **成本优化**：简单任务使用轻量级模型，复杂任务使用强大的模型
+3. **并行处理**：多个模型可以同时处理不同的子任务
+4. **灵活切换**：根据任务需求切换模型，无需重启会话
+5. **利用优势**：结合不同模型的优势以获得最佳整体结果
+
+### 📊 与官方实现的比较
+
+| 功能 | OpenAGI | 官方 Claude |
+|---------|------|-----------------|
+| 支持的模型数量 | 无限，可配置任何模型 | 仅支持单一 Claude 模型 |
+| 模型切换 | ✅ Tab 键快速切换 | ❌ 需要重启会话 |
+| 并行处理 | ✅ 多个子代理并行工作 | ❌ 单线程处理 |
+| 成本跟踪 | ✅ 多个模型分别统计 | ❌ 单一模型成本 |
+| 任务模型配置 | ✅ 不同目的不同默认模型 | ❌ 所有任务使用相同模型 |
+| 专家咨询 | ✅ AskExpertModel 工具 | ❌ 不支持 |
+
+这种多模型协作能力使 OpenAGI 成为真正的 **AI 开发工作台**，而不仅仅是一个单一的 AI 助手。
+
+## 开发
+
+OpenAGI 使用现代工具构建，开发需要 [Bun](https://bun.sh)。
+
+### 安装 Bun
+
+```bash
+# macOS/Linux
+curl -fsSL https://bun.sh/install | bash
+
+# Windows
+powershell -c "irm bun.sh/install.ps1 | iex"
+```
+
+### 设置开发环境
+
+```bash
+# 克隆仓库
+git clone https://github.com/xingshuzhice/openagi.git
+cd openagi
+
+# 安装依赖
+bun install
+
+# 以开发模式运行
+bun run dev
+```
+
+### 构建
+
+```bash
+bun run build
+```
+
+### 测试
+
+```bash
+# 运行测试
+bun test
+
+# 测试 CLI
+./cli.js --help
+```
+
+## 贡献
+
+我们欢迎贡献！详情请参阅我们的[贡献指南](CONTRIBUTING.md)。
 
-1. Copy this entire directory to your desired location
-2. Add the directory to your PATH, or
-3. Create a symlink: `ln -s /path/to/dist/cli.js /usr/local/bin/openagi`
+## 许可证
 
-## Features
+Apache 2.0 许可证 - 详情请参阅 [LICENSE](LICENSE)。
 
-- **@anthropic-ai/claude-code architecture**: Same structure and conventions
-- **Self-contained**: All npm dependencies bundled into cli.js
-- **Optional dependencies**: Platform-specific binaries in node_modules/@img/
-- **SDK included**: TypeScript definitions and ES module SDK
-- **Vendor tools**: Binary utilities in vendor/ directory
+## 致谢
 
-## Dependencies
+- 部分代码来自 @dnakov 的 anonkode
+- 部分 UI 学习自 gemini-cli
+- 部分系统设计学习自 claude code
 
-This distribution is completely self-contained:
-- **ALL** application dependencies are bundled into `cli.js`
-- Only Node.js built-in modules are external
-- Platform-specific optional dependencies for image processing are in node_modules/
-- No additional `npm install` required!
+## 支持
 
-Everything needed to run OpenAGI is included with just Node.js 18+.
+- 📚 [文档](docs/)
+- 🐛 [报告问题](https://github.com/xingshuzhice/openagi/issues)
+- 💬 [讨论](https://github.com/xingshuzhice/openagi/discussions)