Skip to content

Commit 5d5d1b3

Browse files
claude[bot]binggg
claude[bot]
and
binggg
authored
feat: add OpenAI Codex CLI support with MCP integration
- Add TOML configuration file for Codex CLI at config/.codex/config.toml - Update hardlinks script to include Codex CLI configuration - Create comprehensive documentation at doc/ide-setup/openai-codex-cli.md - Add OpenAI Codex CLI to all AI IDE listings in README.md, doc/index.md, and doc/faq.md - Follow established patterns from memory.md workflow 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Booker Zhao <binggg@users.noreply.github.com>
1 parent bde2be6 commit 5d5d1b3

6 files changed

Lines changed: 221 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 51 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>
@@ -615,6 +616,55 @@ gemini
615616

616617
</details>
617618

619+
<details>
620+
<summary><strong>🤖 OpenAI Codex CLI 配置</strong></summary>
621+
622+
#### 步骤1：安装 OpenAI Codex CLI
623+
624+
从 [OpenAI Codex CLI 官网](https://github.com/openai/codex) 下载并安装 OpenAI Codex CLI。
625+
626+
#### 步骤2：配置 CloudBase MCP
627+
628+
> [!TIP]
629+
> 如果安装以后工具数量一直为 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)
630+
631+
如果使用模板项目，MCP 配置已经预置完成。如果不是从模板开始，需要在 `~/.codex/config.toml` 文件中添加：
632+
633+
```toml
634+
# IMPORTANT: the top-level key is `mcp_servers` rather than `mcpServers`.
635+
[mcp_servers.cloudbase]
636+
command = "npx"
637+
args = ["-y", "@cloudbase/cloudbase-mcp@latest"]
638+
```
639+
640+
#### 步骤3：启用 AI 规则
641+
642+
模板中已包含 `CLAUDE.md` 文件，OpenAI Codex CLI 会自动识别云开发最佳实践。如果不是从模板开始，可以让 AI 帮你下载云开发规则：
643+
```
644+
在当前项目中下载云开发 AI 规则
645+
```
646+
647+
#### 步骤4：开始开发
648+
649+
在 OpenAI Codex CLI 中与 AI 对话：
650+
651+
```
652+
登录云开发
653+
```
654+
655+
然后就可以开始开发了，例如：
656+
657+
```
658+
创建一个在线投票系统，支持创建投票、参与投票、结果统计，使用云数据库存储，最后部署
659+
```
660+
661+
**常用命令：**
662+
- `/tools` - 查看可用工具
663+
- `/mcp` - 查看 MCP 服务器状态
664+
- `/memory show` - 查看当前规则
665+
666+
</details>
667+
618668
<details>
619669
<summary><strong>🔄 更新 CloudBase AI ToolKit</strong></summary>
620670

‎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 CloudBase MCP tools in OpenAI Codex CLI
3+
4+
[mcp_servers.cloudbase]
5+
command = "npx"
6+
args = ["-y", "@cloudbase/cloudbase-mcp@latest"]

‎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: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
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 是一个强大的命令行 AI 编程工具，支持 MCP (Model Context Protocol) 集成。结合 CloudBase AI Toolkit，让你通过自然语言描述需求，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. 配置 MCP（具体配置见下方详细步骤）
39+
# 2. 下载 AI 规则
40+
# 3. 开始使用
41+
```
42+
43+
配置完成后，对 AI 说：**"登录云开发"** 即可开始！
44+
45+
## 🔧 详细配置指南
46+
47+
### 步骤 1：安装 OpenAI Codex CLI
48+
49+
从 [OpenAI Codex CLI 官网](https://github.com/openai/codex) 下载并安装 OpenAI Codex CLI。
50+
51+
### 步骤 2：配置 CloudBase MCP
52+
53+
> [!TIP]
54+
> 如果安装以后工具数量一直为 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)
55+
56+
如果使用模板项目，MCP 配置已经预置完成。如果不是从模板开始，需要在 `~/.codex/config.toml` 文件中添加：
57+
58+
```toml
59+
# IMPORTANT: the top-level key is `mcp_servers` rather than `mcpServers`.
60+
[mcp_servers.cloudbase]
61+
command = "npx"
62+
args = ["-y", "@cloudbase/cloudbase-mcp@latest"]
63+
```
64+
65+
### 步骤 3：启用 AI 规则
66+
67+
模板中已包含 `CLAUDE.md` 文件，OpenAI Codex CLI 会自动识别云开发最佳实践。如果不是从模板开始，可以让 AI 帮你下载云开发规则：
68+
```
69+
在当前项目中下载云开发 AI 规则
70+
```
71+
72+
### 步骤 4：开始开发
73+
74+
在 OpenAI Codex CLI 中与 AI 对话：
75+
76+
```
77+
登录云开发
78+
```
79+
80+
## 🎯 开始使用
81+
82+
配置完成后，对 AI 说：
83+
84+
```
85+
登录云开发
86+
```
87+
88+
然后就可以开始开发了，例如：
89+
90+
```
91+
创建一个在线投票系统，支持创建投票、参与投票、结果统计，使用云数据库存储，最后部署
92+
```
93+
94+
OpenAI Codex CLI 支持 MCP 协议，可以直接调用 CloudBase AI Toolkit 的所有工具来完成云开发相关操作。
95+
96+
## 🌟 CloudBase AI Toolkit 开源项目
97+
98+
<div align="center">
99+
100+
### 🔥 加入开源社区
101+
102+
[![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)
103+
[![CNB社区](https://img.shields.io/badge/CNB-CloudBase--AI--ToolKit-orange?style=for-the-badge)](https://cnb.cool/tencent/cloud/cloudbase/CloudBase-AI-ToolKit)
104+
105+
**⭐ Star 项目 | 🤝 贡献代码 | 💬 技术交流**
106+
107+
</div>
108+
109+
## 🛠️ 故障排除
110+
111+
### 常见问题
112+
113+
**Q: MCP 连接失败？**
114+
A:
115+
1. 检查 `~/.codex/config.toml` 文件格式是否正确
116+
2. 确认 npx 命令可用：`npx --version`
117+
3. 重启 OpenAI Codex CLI
118+
4. 检查网络连接状态
119+
120+
**Q: 项目规则未生效？**
121+
A:
122+
1. 确认 `CLAUDE.md` 文件在项目根目录
123+
2. 检查文件内容格式是否正确
124+
3. 重新加载项目或重启 OpenAI Codex CLI
125+
126+
**Q: AI 生成的代码不符合预期？**
127+
A:
128+
1. 详细描述功能需求和技术要求
129+
2. 使用项目模板确保规范一致性
130+
3. 分模块逐步实现复杂项目
131+
132+
更多问题请查看：[完整 FAQ](../faq)
133+
134+
## 📚 相关资源
135+
136+
- [📖 开发指南](../development) - 深入了解开发最佳实践
137+
- [🎯 使用案例](../examples) - 查看实际应用案例
138+
- [🔧 MCP 工具](../mcp-tools) - 了解所有可用工具
139+
- [❓ 常见问题](../faq) - 查看常见问题解答
140+
- [OpenAI Codex CLI 官方文档](https://github.com/openai/codex) - OpenAI Codex CLI 官方文档
141+
142+
## 💬 技术交流
143+
144+
### 微信技术交流群
145+
146+
<div align="center">
147+
<img src="https://7463-tcb-advanced-a656fc-1257967285.tcb.qcloud.la/mcp/toolkit-qrcode.png" width="200" alt="微信群二维码"/>
148+
<br/>
149+
<i>扫码加入微信技术交流群</i>
150+
</div>
151+
152+
---
153+
154+
<div align="center">
155+
156+
**🚀 立即开始使用 OpenAI Codex CLI + CloudBase AI Toolkit**
157+
158+
[开始使用](../getting-started) | [查看模板](../templates) | [GitHub 仓库](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit)
159+
160+
</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/.codex/config.toml"
3132
)
3233

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

0 commit comments

Comments
 (0)