Merge pull request #55 from TencentCloudBase/claude/issue-54-20250710_084932

binggg · web-flow · commit 012784977035 · 2025-07-10T17:18:03.000+08:00
feat: add OpenCode CLI support
diff --git a/README.md b/README.md
@@ -153,6 +153,7 @@ npx -y clear-npx-cache
 | [Claude Code](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/ide-setup/claude-code) | 命令行工具 | [查看指引](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/ide-setup/claude-code) |
 | [Gemini CLI](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/ide-setup/gemini-cli) | 命令行工具 | [查看指引](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/ide-setup/gemini-cli) |
 | [OpenAI Codex CLI](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/ide-setup/openai-codex-cli) | 命令行工具 | [查看指引](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/ide-setup/openai-codex-cli) |
+| [OpenCode](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/ide-setup/opencode) | 命令行工具 | [查看指引](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/ide-setup/opencode) |
 
 
 <details>
@@ -700,6 +701,63 @@ codex --config .codex/config.toml
 
 </details>
 
+<details>
+<summary><strong>🧑‍💻 OpenCode 配置</strong></summary>
+
+#### 步骤1：安装 OpenCode
+
+从 [OpenCode GitHub](https://github.com/opencode-ai/opencode) 下载并安装 OpenCode CLI 工具
+
+#### 步骤2：配置 MCP
+
+> [!TIP] 
+> 如果安装以后工具数量一直为 0，请参考[常见问题](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/faq#mcp-%E6%98%BE%E7%A4%BA%E5%B7%A5%E5%85%B7%E6%95%B0%E9%87%8F%E4%B8%BA-0-%E6%80%8E%E4%B9%88%E5%8A%9E)
+
+如果使用模板项目，MCP 配置已经预置完成。如果不是从模板开始，在项目根目录创建 `.opencode.json` 文件：
+
+```json
+{
+  "mcpServers": {
+    "cloudbase-mcp": {
+      "command": "npx",
+      "args": ["-y", "@cloudbase/cloudbase-mcp@latest"]
+    }
+  }
+}
+```
+
+#### 步骤3：启用 AI 规则
+
+OpenCode 支持多种规则文件格式，模板中已包含 `OPENCODE.md` 文件。如果不是从模板开始，可以让 AI 帮你下载云开发规则：
+
+```
+在当前项目中下载云开发 AI 规则
+```
+
+#### 步骤4：开始开发
+
+启动 OpenCode CLI：
+
+```bash
+opencode
+```
+
+或者直接提问：
+
+```bash
+opencode -p "登录云开发"
+```
+
+在 OpenCode CLI 中与 AI 对话：
+
+```
+登录云开发
+```
+
+然后就可以进行需求的开发了
+
+</details>
+
 <details>
 <summary><strong>🔄 更新 CloudBase AI ToolKit</strong></summary>
 
diff --git a/config/.opencode.json b/config/.opencode.json
@@ -0,0 +1,8 @@
+{
+  "mcpServers": {
+    "cloudbase-mcp": {
+      "command": "npx",
+      "args": ["-y", "@cloudbase/cloudbase-mcp@latest"]
+    }
+  }
+}
diff --git a/doc/faq.md b/doc/faq.md
@@ -19,7 +19,7 @@
 4. 对 AI 说"登录云开发"开始开发
 
 ### 支持哪些 AI 开发工具？
-支持 Cursor、WindSurf、CodeBuddy、CLINE、GitHub Copilot、Claude Code、Gemini CLI、OpenAI Codex CLI、Trae、通义灵码、RooCode、文心快码、Augment Code 等主流 AI 开发工具。
+支持 Cursor、WindSurf、CodeBuddy、CLINE、GitHub Copilot、Claude Code、Gemini CLI、OpenAI Codex CLI、OpenCode、Trae、通义灵码、RooCode、文心快码、Augment Code 等主流 AI 开发工具。
 
 ## 🛠️ 技术问题
 
diff --git a/doc/ide-setup/opencode.md b/doc/ide-setup/opencode.md
@@ -0,0 +1,175 @@
+# CloudBase AI Toolkit + OpenCode
+
+<div align="center">
+
+**🚀 OpenCode + 云开发 = 几分钟内从想法到上线的全栈应用**
+
+[![GitHub Stars](https://img.shields.io/github/stars/TencentCloudBase/CloudBase-AI-ToolKit?style=social)](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit)
+[![开源协议](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit/blob/main/LICENSE)
+
+</div>
+
+> 💡 **为什么选择 OpenCode + CloudBase AI Toolkit？**
+> OpenCode 是一个开源的 AI 编程 CLI 工具，支持多种 AI 模型和 MCP 协议，具有强大的代码生成和项目管理能力。结合 CloudBase AI Toolkit，让你通过自然语言描述需求，AI 自动生成并部署全栈应用到腾讯云开发平台。特别适合命令行开发者、自动化部署场景和多环境管理。
+
+## ✨ 核心优势
+
+| 🎯 **开发效率** | ⚡ **部署速度** | 🛡️ **稳定可靠** |
+|---|---|---|
+| AI 自动生成代码和架构<br/>内置云开发最佳实践规则<br/>智能错误修复和优化 | 一键部署到腾讯云开发<br/>国内 CDN 加速访问<br/>Serverless 架构免运维 | 330万开发者验证的平台<br/>企业级安全和稳定性<br/>完善的监控和日志系统 |
+
+## 🚀 5分钟快速开始
+
+### 方式一：使用项目模板（推荐）
+
+选择预配置的项目模板，开箱即用：
+
+<div align="center">
+
+**[📦 查看所有项目模板](../templates)**
+
+</div>
+
+### 方式二：现有项目集成
+
+如果你已有项目，只需 3 步集成：
+
+```bash
+# 1. 配置 MCP（具体配置见下方详细步骤）
+# 2. 下载 AI 规则
+# 3. 开始使用
+```
+
+配置完成后，运行 OpenCode 并说：**"登录云开发"** 即可开始！
+
+## 🔧 详细配置指南
+
+### 步骤 1：安装 OpenCode
+
+从 [OpenCode GitHub](https://github.com/opencode-ai/opencode) 下载并安装 OpenCode CLI 工具。
+
+```bash
+# 使用 npm 安装
+npm install -g opencode
+
+# 或者使用 yarn
+yarn global add opencode
+
+# 或者直接从 GitHub 下载二进制文件
+```
+
+### 步骤 2：配置 CloudBase MCP
+
+> [!TIP] 
+> 如果安装以后工具数量一直为 0，请参考[常见问题](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/faq#mcp-%E6%98%BE%E7%A4%BA%E5%B7%A5%E5%85%B7%E6%95%B0%E9%87%8F%E4%B8%BA-0-%E6%80%8E%E4%B9%88%E5%8A%9E)
+
+在项目根目录创建 `.opencode.json` 文件：
+
+```json
+{
+  "mcpServers": {
+    "cloudbase-mcp": {
+      "command": "npx",
+      "args": ["-y", "@cloudbase/cloudbase-mcp@latest"]
+    }
+  }
+}
+```
+
+### 步骤 3：启用 AI 规则
+
+OpenCode 支持多种规则文件格式，已包含 `OPENCODE.md` 规则文件。如果是现有项目，对 AI 说：
+```
+在当前项目中下载云开发 AI 规则
+```
+
+### 步骤 4：开始开发
+
+使用 OpenCode CLI 与 AI 对话：
+
+```bash
+# 启动 OpenCode
+opencode
+
+# 或者直接提问
+opencode "登录云开发"
+```
+
+## 🎯 开始使用
+
+配置完成后，对 AI 说：
+
+```
+登录云开发
+```
+
+然后就可以开始开发了，例如：
+
+```
+创建一个在线投票系统，支持创建投票、参与投票、结果统计，使用云数据库存储，最后部署
+```
+
+## 🌟 CloudBase AI Toolkit 开源项目
+
+<div align="center">
+
+### 🔥 加入开源社区
+
+[![GitHub](https://img.shields.io/badge/GitHub-TencentCloudBase/CloudBase--AI--ToolKit-black?style=for-the-badge&logo=github)](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit)
+[![CNB社区](https://img.shields.io/badge/CNB-CloudBase--AI--ToolKit-orange?style=for-the-badge)](https://cnb.cool/tencent/cloud/cloudbase/CloudBase-AI-ToolKit)
+
+**⭐ Star 项目 | 🤝 贡献代码 | 💬 技术交流**
+
+</div>
+
+## 🛠️ 故障排除
+
+### 常见问题
+
+**Q: MCP 连接失败？**
+A:
+1. 检查配置文件格式是否正确
+2. 重启 OpenCode
+3. 确认网络连接正常
+4. 检查 Node.js 版本（建议 18+）
+
+**Q: AI 生成的代码不符合预期？**
+A:
+1. 明确描述技术栈和框架要求
+2. 使用项目模板确保规范一致性
+3. 提供更详细的需求描述
+
+**Q: 命令行工具无响应？**
+A:
+1. 检查是否正确安装了 OpenCode
+2. 确认 MCP 服务器配置正确
+3. 尝试重新启动终端
+
+更多问题请查看：[完整 FAQ](../faq)
+
+## 📚 相关资源
+
+- [📖 开发指南](../development) - 深入了解开发最佳实践
+- [🎯 使用案例](../examples) - 查看实际应用案例
+- [🔧 MCP 工具](../mcp-tools) - 了解所有可用工具
+- [❓ 常见问题](../faq) - 查看常见问题解答
+
+## 💬 技术交流
+
+### 微信技术交流群
+
+<div align="center">
+<img src="https://7463-tcb-advanced-a656fc-1257967285.tcb.qcloud.la/mcp/toolkit-qrcode.png" width="200" alt="微信群二维码"/>
+<br/>
+<i>扫码加入微信技术交流群</i>
+</div>
+
+---
+
+<div align="center">
+
+**🚀 立即开始使用 OpenCode + CloudBase AI Toolkit**
+
+[开始使用](../getting-started) | [查看模板](../templates) | [GitHub 仓库](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit)
+
+</div>
diff --git a/doc/index.md b/doc/index.md
@@ -14,7 +14,7 @@
 
 </div>
 
-当你在**Cursor/ VSCode GitHub Copilot/WinSurf/CodeBuddy/Augment Code/Claude Code/OpenAI Codex CLI**等AI编程工具里写代码时，它能自动帮你生成可直接部署的前后端应用+小程序，并一键发布到腾讯云开发 CloudBase。
+当你在**Cursor/ VSCode GitHub Copilot/WinSurf/CodeBuddy/Augment Code/Claude Code/OpenAI Codex CLI/OpenCode**等AI编程工具里写代码时，它能自动帮你生成可直接部署的前后端应用+小程序，并一键发布到腾讯云开发 CloudBase。
 
 :::tip 🌟 开源项目
 - **GitHub 仓库**: [TencentCloudBase/CloudBase-AI-ToolKit](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit) - 欢迎 Star 和贡献代码
@@ -61,6 +61,7 @@
 | [Claude Code](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/ide-setup/claude-code) | 命令行工具 | [查看指引](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/ide-setup/claude-code) |
 | [Gemini CLI](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/ide-setup/gemini-cli) | 命令行工具 | [查看指引](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/ide-setup/gemini-cli) |
 | [OpenAI Codex CLI](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/ide-setup/openai-codex-cli) | 命令行工具 | [查看指引](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/ide-setup/openai-codex-cli) |
+| [OpenCode](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/ide-setup/opencode) | 命令行工具 | [查看指引](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/ide-setup/opencode) |
 
 ## 🎯 快速导航
 
