Skip to content

Commit bc5e5cd

Browse files
authored
chore: update codebuddy setup doc (#122)
1 parent 2ca8001 commit bc5e5cd

File tree

1 file changed

+95
-44
lines changed

1 file changed

+95
-44
lines changed

doc/ide-setup/codebuddy.md

Lines changed: 95 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -23,49 +23,46 @@
2323
|---|---|---|
2424
| AI 自动生成代码和架构<br/>内置云开发最佳实践规则<br/>智能错误修复和优化 | 一键部署到腾讯云开发<br/>国内 CDN 加速访问<br/>Serverless 架构免运维 | 330万开发者验证的平台<br/>企业级安全和稳定性<br/>完善的监控和日志系统 |
2525

26-
## 🚀 5分钟快速开始
26+
## 前提条件
2727

28-
### 方式一:使用项目模板(推荐)
28+
1. **开通云开发**:请参考文档 [开通云开发环境](https://docs.cloudbase.net/quick-start/create-env)
29+
2. **安装 CodeBuddy**:根据您的开发环境选择对应版本
2930

30-
选择预配置的项目模板,开箱即用:
31-
32-
<div align="center">
31+
## 🔧 配置指南
3332

34-
**[📦 查看所有项目模板](../templates)**
33+
### 1. 配置 CloudBase ToolKit
3534

36-
</div>
35+
#### CodeBuddy IDE版
3736

38-
### 方式二:现有项目集成
37+
**CodeBuddy IDE** 用户请直接在设置页/集成点击"Tencent CloudBase"管理按钮并授权,无需手动配置 MCP:
3938

40-
如果你已有项目,只需 3 步集成:
39+
![CodeBuddy IDE 集成配置](https://qcloudimg.tencent-cloud.cn/raw/181adab137d74530cbc2b73b280aa2d6.png)
4140

42-
```bash
43-
# 1. 配置 MCP(具体配置见下方详细步骤)
44-
# 2. 下载 AI 规则
45-
# 3. 开始使用
46-
```
41+
#### CodeBuddy 插件版
4742

48-
配置完成后,对 AI 说:**"登录云开发"** 即可开始!
43+
##### 步骤 1:安装 CodeBuddy
4944

50-
## 🔧 详细配置指南
45+
根据您的开发环境选择安装方式:
5146

52-
> 💡 **CodeBuddy 独立 IDE 用户请直接在对话框点击“配置集成”按钮并授权,无需手动配置 MCP。**
47+
* **VS Code**: 在扩展商店搜索 "CodeBuddy" 安装
48+
* **JetBrains**: 在插件市场搜索 "CodeBuddy" 安装
49+
* **微信开发者工具**: 从腾讯云官网下载插件
5350

54-
### 步骤 1:安装 CodeBuddy
51+
##### 步骤 2:配置 CloudBase MCP
5552

56-
根据你的开发环境选择安装方式:
53+
**方式一:通过 MCP 市场安装(推荐)**
5754

58-
- **VS Code**: 在扩展商店搜索 "CodeBuddy" 安装
59-
- **JetBrains**: 在插件市场搜索 "CodeBuddy" 安装
60-
- **微信开发者工具**: 从腾讯云官网下载插件
55+
1. 点击 CodeBuddy 右上角的 MCP 按钮
56+
2. 在 MCP 市场中搜索 CloudBase
57+
3. 点击安装即可
6158

62-
### 步骤 2:配置 CloudBase MCP
59+
![MCP 市场安装](https://qcloudimg.tencent-cloud.cn/raw/e23e9eb8a71a63c85a6fcb3845e62536.png)
6360

64-
> [!TIP]
65-
> 如果安装以后工具数量一直为 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)
61+
**方式二:手动配置**
6662

67-
1. 可以在 点开 CodeBuddy 右上角的 MCP 按钮,在 MCP 市场中搜索 CloudBase,然后点击安装即可。
68-
2. 也可以选择手动安装,点开 CodeBuddy 右上角的 MCP 按钮,点击右侧的添加,在 MCP 配置中添加:
63+
1. 点击 CodeBuddy 右上角的 MCP 按钮
64+
2. 点击右侧的添加按钮
65+
3. 在 MCP 配置中添加以下内容:
6966

7067
```json
7168
{
@@ -78,41 +75,95 @@
7875
}
7976
```
8077

81-
### 步骤 3:启用 AI 规则
78+
![手动配置 MCP](https://qcloudimg.tencent-cloud.cn/raw/318db1a04f1f936924d2c4d1eaed1e5c.png)
79+
80+
> **故障排查**:如果安装后工具数量显示为 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)
81+
82+
### 2. 项目初始化
83+
84+
#### 方式一:使用项目模板(推荐)
85+
86+
选择预配置的项目模板,开箱即用:
87+
88+
<div align="center">
89+
90+
**[📦 查看所有项目模板](https://docs.cloudbase.net/ai/cloudbase-ai-toolkit/templates)**
91+
92+
</div>
93+
94+
模板项目已包含 `.rules/` 目录,无需手动配置 AI 规则,可以直接开始开发。
95+
96+
#### 方式二:现有项目集成
97+
98+
如果您已有项目,在 Craft 模式下对 CodeBuddy 说:
8299

83-
模板项目已包含 `.rules/` 目录。如果是现有项目,对 AI 说:
84100
```
85101
在当前项目中下载云开发 AI 规则
86102
```
87103

88-
如果你只想下载CodeBuddy相关的配置文件,避免项目文件混乱,可以指定IDE类型:
104+
如果您只想下载 CodeBuddy 相关的配置文件,避免项目文件混乱,可以指定:
105+
89106
```
90-
在当前项目中下载云开发 AI 规则,只包含CodeBuddy配置
107+
在当前项目中下载云开发 AI 规则,只包含 CodeBuddy 配置
91108
```
92109

93-
### 步骤 4:开始开发
110+
## 实战案例:在线投票系统
111+
112+
### 1. 需求描述
94113

95-
在 Craft 模式下与 AI 对话(建议关闭确认计划功能)
114+
**Craft** 模式下,选中 `Plan Mode` 模式对 CodeBuddy 说
96115

97116
```
98-
登录云开发
117+
创建一个在线投票系统,支持创建投票、参与投票、结果统计,使用云数据库存储,最后部署
99118
```
100119

101-
## 🎯 开始使用
120+
### 2. 需求分析
102121

103-
配置完成后,对 AI 说
122+
CodeBuddy 会自动分析需求并生成规范的需求文档
104123

105-
```
106-
登录云开发
107-
```
124+
![需求分析过程](https://qcloudimg.tencent-cloud.cn/raw/4857ac3e9b676b9196d83e8dbb26f4c1.png)
108125

109-
然后就可以开始开发了,例如:
126+
![需求文档生成](https://qcloudimg.tencent-cloud.cn/raw/e020d3e49c45b5c5dcc418b7c113bee1.png)
110127

111-
```
112-
创建一个在线投票系统,支持创建投票、参与投票、结果统计,使用云数据库存储,最后部署
113-
```
128+
### 3. 确认需求
129+
130+
需求讨论完毕后,CodeBuddy 会总结并确认需求文档。确认无误后,点击 `继续` 开始生成代码:
131+
132+
![需求确认](https://qcloudimg.tencent-cloud.cn/raw/e279e5a1b5ac1665e43f695a2b1795a2.png)
133+
134+
### 4. 自动开发
135+
136+
编写代码过程中,CodeBuddy 会自动调用 **CloudBase ToolKit** 进行数据库创建:
137+
138+
![数据库创建](https://qcloudimg.tencent-cloud.cn/raw/28a37244afe96630c5db118d235eb774.png)
139+
140+
### 5. 一键部署
141+
142+
开发完成后,CodeBuddy 会调用 **CloudBase ToolKit** 直接部署前端资源到云开发:
143+
144+
![资源部署](https://qcloudimg.tencent-cloud.cn/raw/b8c08a2da14567128c1a1c5c6053d7b2.png)
145+
146+
至此,我们通过一句简单的需求描述,借助 **CodeBuddy****CloudBase AI Toolkit** 完成了需求分析、代码生成、数据库创建、前后端部署等一系列工作。
147+
148+
## 效果展示
149+
150+
### 投票列表
151+
152+
![投票列表页面](https://qcloudimg.tencent-cloud.cn/raw/e1ee4103c6271c342d189b24e0b96914.png)
153+
154+
### 新建投票
155+
156+
![新建投票页面](https://qcloudimg.tencent-cloud.cn/raw/4b7774a49bcad87431082a723e8aa5de.png)
157+
158+
### 投票详情
159+
160+
![投票详情页面](https://qcloudimg.tencent-cloud.cn/raw/ee6e21beb9fcfd75b24e55033ce31f39.png)
161+
162+
### 个人中心
163+
164+
![个人中心页面](https://qcloudimg.tencent-cloud.cn/raw/12c67750fff593a11b900f1fa96e9835.png)
114165

115-
CodeBuddy 特别适合小程序开发,支持微信开发者工具集成。
166+
**在线体验**[https://lowcode-9g2yhkab1a980408-1308771514.tcloudbaseapp.com/vote_base/](https://lowcode-9g2yhkab1a980408-1308771514.tcloudbaseapp.com/vote_base/)
116167

117168
## 🛠️ 故障排除
118169

0 commit comments

Comments
 (0)