Skip to content

Commit e19c9f2

Browse files
authored
Merge pull request #45 from TencentCloudBase/claude/issue-18-20250709_031949
feat: add OpenAI Codex CLI support with MCP integration
2 parents 43ed05c + 7322612 commit e19c9f2

7 files changed

Lines changed: 534 additions & 3 deletions

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
[![CNB 镜像](https://img.shields.io/badge/CNB-CloudBase--AI--ToolKit-blue?logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHZpZXdCb3g9IjAgMCAxMiAxMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cmVjdCB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHJ4PSIyIiBmaWxsPSIjM0I4MkY2Ii8+PHBhdGggZD0iTTUgM0g3VjVINSIgc3Ryb2tlPSJ3aGl0ZSIgc3Ryb2tlLXdpZHRoPSIxLjUiLz48cGF0aCBkPSJNNSA3SDdWOUg1IiBzdHJva2U9IndoaXRlIiBzdHJva2Utd2lkdGg9IjEuNSIvPjwvc3ZnPg==)](https://cnb.cool/tencent/cloud/cloudbase/CloudBase-AI-ToolKit)
2525
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/TencentCloudBase/CloudBase-AI-ToolKit)
2626

27-
当你在**Cursor/ VSCode GitHub Copilot/WinSurf/CodeBuddy/Augment Code/Claude Code**等AI编程工具里写代码时,它能自动帮你生成可直接部署的前后端应用+小程序,并一键发布到腾讯云开发 CloudBase。
27+
当你在**Cursor/ VSCode GitHub Copilot/WinSurf/CodeBuddy/Augment Code/Claude Code/OpenAI Codex CLI**等AI编程工具里写代码时,它能自动帮你生成可直接部署的前后端应用+小程序,并一键发布到腾讯云开发 CloudBase。
2828

2929

3030
**📹 完整视频演示 ⬇️**
@@ -150,6 +150,7 @@ npx -y clear-npx-cache
150150
| [Augment Code](https://www.augmentcode.com/) | VS Code、JetBrains 插件 |
151151
| [Claude Code](https://www.anthropic.com/claude-code) | 命令行工具 |
152152
| [Gemini CLI](https://github.com/google-gemini/gemini-cli) | 命令行工具 |
153+
| [OpenAI Codex CLI](https://github.com/openai/codex) | 命令行工具 |
153154

154155
<details>
155156
<summary><strong>🔧 Cursor 配置</strong></summary>

config/.codex/config.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# OpenAI Codex CLI Configuration for CloudBase AI ToolKit
2+
# This configuration enables MCP (Model Context Protocol) support for CloudBase tools
3+
4+
[mcp_servers.cloudbase]
5+
command = "npx"
6+
args = ["-y", "@cloudbase/cloudbase-mcp@latest"]

config/AGENTS.md

Lines changed: 321 additions & 0 deletions
Large diffs are not rendered by default.

doc/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
4. 对 AI 说"登录云开发"开始开发
2020

2121
### 支持哪些 AI 开发工具?
22-
支持 Cursor、WindSurf、CodeBuddy、CLINE、GitHub Copilot、Claude Code、Gemini CLI、Trae、通义灵码、RooCode、文心快码、Augment Code 等主流 AI 开发工具。
22+
支持 Cursor、WindSurf、CodeBuddy、CLINE、GitHub Copilot、Claude Code、Gemini CLI、OpenAI Codex CLI、Trae、通义灵码、RooCode、文心快码、Augment Code 等主流 AI 开发工具。
2323

2424
## 🛠️ 技术问题
2525

doc/ide-setup/openai-codex-cli.md

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
# CloudBase AI Toolkit + OpenAI Codex CLI
2+
3+
<div align="center">
4+
5+
**🚀 OpenAI Codex CLI + 云开发 = 几分钟内从想法到上线的全栈应用**
6+
7+
[![GitHub Stars](https://img.shields.io/github/stars/TencentCloudBase/CloudBase-AI-ToolKit?style=social)](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit)
8+
[![开源协议](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit/blob/main/LICENSE)
9+
10+
</div>
11+
12+
> 💡 **为什么选择 OpenAI Codex CLI + CloudBase AI Toolkit?**
13+
> OpenAI Codex CLI 是基于 OpenAI Codex 模型的命令行工具,支持 MCP (Model Context Protocol) 协议,具有强大的代码生成和理解能力。结合 CloudBase AI Toolkit,让你通过自然语言描述需求,AI 自动生成并部署全栈应用到腾讯云开发平台。特别适合命令行开发者和需要高效 AI 辅助开发的场景。
14+
15+
## ✨ 核心优势
16+
17+
| 🎯 **开发效率** |**部署速度** | 🛡️ **稳定可靠** |
18+
|---|---|---|
19+
| AI 自动生成代码和架构<br/>内置云开发最佳实践规则<br/>命令行高效交互方式 | 一键部署到腾讯云开发<br/>国内 CDN 加速访问<br/>Serverless 架构免运维 | 330万开发者验证的平台<br/>企业级安全和稳定性<br/>完善的监控和日志系统 |
20+
21+
## 🚀 5分钟快速开始
22+
23+
### 方式一:使用项目模板(推荐)
24+
25+
选择预配置的项目模板,开箱即用:
26+
27+
<div align="center">
28+
29+
**[📦 查看所有项目模板](../templates)**
30+
31+
</div>
32+
33+
### 方式二:现有项目集成
34+
35+
如果你已有项目,只需 3 步集成:
36+
37+
```bash
38+
# 1. 安装 OpenAI Codex CLI
39+
# 2. 配置 MCP(具体配置见下方详细步骤)
40+
# 3. 启动 Codex CLI 并开始使用
41+
```
42+
43+
配置完成后,对 AI 说:**"登录云开发"** 即可开始!
44+
45+
## 🔧 详细配置指南
46+
47+
### 步骤 1:安装 OpenAI Codex CLI
48+
49+
```bash
50+
npm install -g @openai/codex
51+
```
52+
53+
### 步骤 2:配置 CloudBase MCP
54+
55+
> [!TIP]
56+
> 如果安装以后工具数量一直为 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)
57+
58+
如果使用模板项目,MCP 配置已经预置完成。如果不是从模板开始,有两种配置方式:
59+
60+
#### 方式一:使用项目配置文件(推荐)
61+
62+
在项目根目录创建 `.codex/config.toml` 文件:
63+
64+
```toml
65+
[mcp_servers.cloudbase]
66+
command = "npx"
67+
args = ["-y", "@cloudbase/cloudbase-mcp@latest"]
68+
```
69+
70+
然后启动时指定配置文件:
71+
72+
```bash
73+
codex --config .codex/config.toml
74+
```
75+
76+
#### 方式二:全局配置
77+
78+
在用户主目录创建 `~/.codex/config.toml` 文件:
79+
80+
```toml
81+
[mcp_servers.cloudbase]
82+
command = "npx"
83+
args = ["-y", "@cloudbase/cloudbase-mcp@latest"]
84+
```
85+
86+
### 步骤 3:启用 AI 规则
87+
88+
模板中已包含 `AGENTS.md` 文件,OpenAI Codex CLI 会自动识别云开发最佳实践。如果不是从模板开始,可以让 AI 帮你下载云开发规则:
89+
90+
```
91+
在当前项目中下载云开发 AI 规则
92+
```
93+
94+
### 步骤 4:开始开发
95+
96+
启动 OpenAI Codex CLI:
97+
98+
```bash
99+
codex
100+
```
101+
102+
如果使用项目配置文件:
103+
104+
```bash
105+
codex --config .codex/config.toml
106+
```
107+
108+
在 Codex CLI 中与 AI 对话:
109+
110+
```
111+
登录云开发
112+
```
113+
114+
## 🎯 常用命令
115+
116+
配置完成后,可以使用以下命令:
117+
118+
**常用命令:**
119+
- `/tools` - 查看可用工具
120+
- `/mcp` - 查看 MCP 服务器状态
121+
- `/memory show` - 查看当前规则
122+
123+
然后就可以开始开发了,例如:
124+
125+
```
126+
创建一个在线投票系统,支持创建投票、参与投票、结果统计,使用云数据库存储,最后部署
127+
```
128+
129+
OpenAI Codex CLI 具有强大的代码理解能力,能够深度分析项目结构并生成高质量的代码。
130+
131+
## 🌟 CloudBase AI Toolkit 开源项目
132+
133+
<div align="center">
134+
135+
### 🔥 加入开源社区
136+
137+
[![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)
138+
[![CNB社区](https://img.shields.io/badge/CNB-CloudBase--AI--ToolKit-orange?style=for-the-badge)](https://cnb.cool/tencent/cloud/cloudbase/CloudBase-AI-ToolKit)
139+
140+
**⭐ Star 项目 | 🤝 贡献代码 | 💬 技术交流**
141+
142+
</div>
143+
144+
## 🛠️ 故障排除
145+
146+
### 常见问题
147+
148+
**Q: MCP 连接失败?**
149+
A:
150+
1. 检查 `.codex/config.toml` 文件格式是否正确
151+
2. 确认 npx 命令可用:`npx --version`
152+
3. 重启 Codex CLI 应用
153+
4. 检查网络连接状态
154+
155+
**Q: 项目规则未生效?**
156+
A:
157+
1. 确认 `AGENTS.md` 文件在项目根目录
158+
2. 检查文件内容格式是否正确
159+
3. 重新启动 Codex CLI
160+
161+
**Q: AI 生成的代码不符合预期?**
162+
A:
163+
1. 详细描述功能需求和技术要求
164+
2. 使用项目模板确保规范一致性
165+
3. 分模块逐步实现复杂项目
166+
167+
**Q: 如何使用项目配置文件?**
168+
A:
169+
1. 在项目根目录创建 `.codex/config.toml` 文件
170+
2. 启动时使用 `codex --config .codex/config.toml`
171+
3. 这样可以为不同项目使用不同的配置
172+
173+
更多问题请查看:[完整 FAQ](../faq)
174+
175+
## 📚 相关资源
176+
177+
- [📖 开发指南](../development) - 深入了解开发最佳实践
178+
- [🎯 使用案例](../examples) - 查看实际应用案例
179+
- [🔧 MCP 工具](../mcp-tools) - 了解所有可用工具
180+
- [❓ 常见问题](../faq) - 查看常见问题解答
181+
- [OpenAI Codex CLI 官方文档](https://github.com/openai/codex) - OpenAI Codex CLI 官方文档
182+
183+
## 💬 技术交流
184+
185+
### 微信技术交流群
186+
187+
<div align="center">
188+
<img src="https://7463-tcb-advanced-a656fc-1257967285.tcb.qcloud.la/mcp/toolkit-qrcode.png" width="200" alt="微信群二维码"/>
189+
<br/>
190+
<i>扫码加入微信技术交流群</i>
191+
</div>
192+
193+
---
194+
195+
<div align="center">
196+
197+
**🚀 立即开始使用 OpenAI Codex CLI + CloudBase AI Toolkit**
198+
199+
[开始使用](../getting-started) | [查看模板](../templates) | [GitHub 仓库](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit)
200+
201+
</div>

doc/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
</div>
1616

17-
当你在**Cursor/ VSCode GitHub Copilot/WinSurf/CodeBuddy/Augment Code/Claude Code**等AI编程工具里写代码时,它能自动帮你生成可直接部署的前后端应用+小程序,并一键发布到腾讯云开发 CloudBase。
17+
当你在**Cursor/ VSCode GitHub Copilot/WinSurf/CodeBuddy/Augment Code/Claude Code/OpenAI Codex CLI**等AI编程工具里写代码时,它能自动帮你生成可直接部署的前后端应用+小程序,并一键发布到腾讯云开发 CloudBase。
1818

1919
:::tip 🌟 开源项目
2020
- **GitHub 仓库**: [TencentCloudBase/CloudBase-AI-ToolKit](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit) - 欢迎 Star 和贡献代码
@@ -60,6 +60,7 @@
6060
| [Augment Code](./ide-setup/augment-code) | VS Code、JetBrains 插件 |
6161
| [Claude Code](./ide-setup/claude-code) | 命令行工具 |
6262
| [Gemini CLI](./ide-setup/gemini-cli) | 命令行工具 |
63+
| [OpenAI Codex CLI](./ide-setup/openai-codex-cli) | 命令行工具 |
6364

6465
## 🎯 快速导航
6566

scripts/fix-config-hardlinks.sh

100755100644
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ TARGET_FILES=(
2828
"config/.augment-guidelines"
2929
"config/CLAUDE.md"
3030
"config/.gemini/GEMINI.md"
31+
"config/AGENTS.md"
3132
)
3233

3334
echo -e "${BLUE}🔧 CloudBase AI 配置文件硬链接修复工具${NC}"

0 commit comments

Comments
 (0)