Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 51 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
[![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)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/TencentCloudBase/CloudBase-AI-ToolKit)

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


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

<details>
<summary><strong>🔧 Cursor 配置</strong></summary>
Expand Down Expand Up @@ -615,6 +616,55 @@ gemini

</details>

<details>
<summary><strong>🤖 OpenAI Codex CLI 配置</strong></summary>

#### 步骤1:安装 OpenAI Codex CLI

从 [OpenAI Codex CLI 官网](https://github.com/openai/codex) 下载并安装 OpenAI Codex CLI。

#### 步骤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)

如果使用模板项目,MCP 配置已经预置完成。如果不是从模板开始,需要在 `~/.codex/config.toml` 文件中添加:

```toml
# IMPORTANT: the top-level key is `mcp_servers` rather than `mcpServers`.
[mcp_servers.cloudbase]
command = "npx"
args = ["-y", "@cloudbase/cloudbase-mcp@latest"]
```

#### 步骤3:启用 AI 规则

模板中已包含 `CLAUDE.md` 文件,OpenAI Codex CLI 会自动识别云开发最佳实践。如果不是从模板开始,可以让 AI 帮你下载云开发规则:
```
在当前项目中下载云开发 AI 规则
```

#### 步骤4:开始开发

在 OpenAI Codex CLI 中与 AI 对话:

```
登录云开发
```

然后就可以开始开发了,例如:

```
创建一个在线投票系统,支持创建投票、参与投票、结果统计,使用云数据库存储,最后部署
```

**常用命令:**
- `/tools` - 查看可用工具
- `/mcp` - 查看 MCP 服务器状态
- `/memory show` - 查看当前规则

</details>

<details>
<summary><strong>🔄 更新 CloudBase AI ToolKit</strong></summary>

Expand Down
6 changes: 6 additions & 0 deletions config/.codex/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# OpenAI Codex CLI Configuration for CloudBase AI ToolKit
# This configuration enables CloudBase MCP tools in OpenAI Codex CLI

[mcp_servers.cloudbase]
command = "npx"
args = ["-y", "@cloudbase/cloudbase-mcp@latest"]
2 changes: 1 addition & 1 deletion doc/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
4. 对 AI 说"登录云开发"开始开发

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

## 🛠️ 技术问题

Expand Down
160 changes: 160 additions & 0 deletions doc/ide-setup/openai-codex-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
# CloudBase AI Toolkit + OpenAI Codex CLI

<div align="center">

**🚀 OpenAI Codex CLI + 云开发 = 几分钟内从想法到上线的全栈应用**

[![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>

> 💡 **为什么选择 OpenAI Codex CLI + CloudBase AI Toolkit?**
> OpenAI Codex CLI 是一个强大的命令行 AI 编程工具,支持 MCP (Model Context Protocol) 集成。结合 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. 开始使用
```

配置完成后,对 AI 说:**"登录云开发"** 即可开始!

## 🔧 详细配置指南

### 步骤 1:安装 OpenAI Codex CLI

从 [OpenAI Codex CLI 官网](https://github.com/openai/codex) 下载并安装 OpenAI Codex CLI。

### 步骤 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)

如果使用模板项目,MCP 配置已经预置完成。如果不是从模板开始,需要在 `~/.codex/config.toml` 文件中添加:

```toml
# IMPORTANT: the top-level key is `mcp_servers` rather than `mcpServers`.
[mcp_servers.cloudbase]
command = "npx"
args = ["-y", "@cloudbase/cloudbase-mcp@latest"]
```

### 步骤 3:启用 AI 规则

模板中已包含 `CLAUDE.md` 文件,OpenAI Codex CLI 会自动识别云开发最佳实践。如果不是从模板开始,可以让 AI 帮你下载云开发规则:
```
在当前项目中下载云开发 AI 规则
```

### 步骤 4:开始开发

在 OpenAI Codex CLI 中与 AI 对话:

```
登录云开发
```

## 🎯 开始使用

配置完成后,对 AI 说:

```
登录云开发
```

然后就可以开始开发了,例如:

```
创建一个在线投票系统,支持创建投票、参与投票、结果统计,使用云数据库存储,最后部署
```

OpenAI Codex CLI 支持 MCP 协议,可以直接调用 CloudBase AI Toolkit 的所有工具来完成云开发相关操作。

## 🌟 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. 检查 `~/.codex/config.toml` 文件格式是否正确
2. 确认 npx 命令可用:`npx --version`
3. 重启 OpenAI Codex CLI
4. 检查网络连接状态

**Q: 项目规则未生效?**
A:
1. 确认 `CLAUDE.md` 文件在项目根目录
2. 检查文件内容格式是否正确
3. 重新加载项目或重启 OpenAI Codex CLI

**Q: AI 生成的代码不符合预期?**
A:
1. 详细描述功能需求和技术要求
2. 使用项目模板确保规范一致性
3. 分模块逐步实现复杂项目

更多问题请查看:[完整 FAQ](../faq)

## 📚 相关资源

- [📖 开发指南](../development) - 深入了解开发最佳实践
- [🎯 使用案例](../examples) - 查看实际应用案例
- [🔧 MCP 工具](../mcp-tools) - 了解所有可用工具
- [❓ 常见问题](../faq) - 查看常见问题解答
- [OpenAI Codex CLI 官方文档](https://github.com/openai/codex) - OpenAI Codex CLI 官方文档

## 💬 技术交流

### 微信技术交流群

<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">

**🚀 立即开始使用 OpenAI Codex CLI + CloudBase AI Toolkit**

[开始使用](../getting-started) | [查看模板](../templates) | [GitHub 仓库](https://github.com/TencentCloudBase/CloudBase-AI-ToolKit)

</div>
3 changes: 2 additions & 1 deletion doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

</div>

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

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

## 🎯 快速导航

Expand Down
1 change: 1 addition & 0 deletions scripts/fix-config-hardlinks.sh
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ TARGET_FILES=(
"config/.augment-guidelines"
"config/CLAUDE.md"
"config/.gemini/GEMINI.md"
"config/.codex/config.toml"
)

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