腾讯云CodeBuddy完全对接指南:从安装配置到企业级集成实践
腾讯云CodeBuddy是一款基于腾讯云AI技术的智能编程工具,深度集成腾讯云生态,提供从代码编写到项目部署的全链路AI辅助。CodeBuddy同时支持IDE插件、独立IDE和CLI三种形态,覆盖从专业开发者到零基础用户的全场景需求。本文将从零开始,系统讲解CodeBuddy的对接使用方法,涵盖安装配置、API接入、第三方集成、部署对接等全流程操作。
需要先登录腾讯云控制台,点击:腾讯云控制台,还没有账号,点击:注册后再关联,已有账号点击:登录后再关联
一、CodeBuddy产品形态与选型
CodeBuddy提供三种产品形态,开发者可根据自身场景选择:
CodeBuddy插件版:以插件形式安装到VS Code、JetBrains系列等IDE中,即插即用、零成本学习,适合日常编码开发者。插件版提供代码补全、错误修复、单元测试生成、代码审查等核心功能。
CodeBuddy IDE:独立的AI原生IDE,主打"对话即编程",将AI深度融入从需求规划、产品设计到代码研发、产品部署的全流程。适合产品经理、设计师、全栈开发者和编程初学者。
CodeBuddy Code(CLI):面向专业工程师的AI命令行工具,支持在命令行中用自然语言驱动开发全流程,实现高度自动化。适合DevOps、运维、SRE及资深开发者。
二、CodeBuddy插件安装与接入
2.1 Visual Studio Code插件安装
在VS Code中安装CodeBuddy插件最为便捷。打开VS Code,进入扩展市场(Extensions),搜索"腾讯云代码助手"或"CodeBuddy",点击安装即可。安装完成后,VS Code侧边栏会出现CodeBuddy图标,点击即可打开对话面板。
2.2 JetBrains系列IDE插件安装
在JetBrains系列IDE(如IntelliJ IDEA、PyCharm等)中,进入Settings → Plugins,搜索"Tencent Cloud CodeBuddy"或"腾讯云代码助手"进行安装。安装完成后重启IDE即可使用。
2.3 Visual Studio插件安装
Visual Studio用户可通过两种方式安装CodeBuddy插件:
方式一:手动下载安装包。访问Visual Studio市场,搜索"Tencent Cloud CodeBuddy"下载插件安装程序,双击运行安装。
方式二:IDE内安装。在Visual Studio顶部菜单栏中单击"扩展"→"管理扩展",搜索"腾讯云代码助手CodeBuddy",单击安装。关闭Visual Studio后,在弹出的VSIX Installer窗口中单击Modify执行下载。
Visual Studio最低版本要求17.6及以上。
2.4 插件登录
安装完成后,打开IDE即可看到CodeBuddy登录界面。使用腾讯云账号扫码或账号密码登录即可开始使用。
三、CodeBuddy CLI安装与配置
3.1 安装CodeBuddy CLI
CodeBuddy CLI(即CodeBuddy Code)可通过npm全局安装:
npm install -g @tencent-ai/codebuddy-code
安装前请确保本地已安装Node.js 18.0及以上版本。
3.2 获取API Key
使用CodeBuddy CLI需要配置API Key进行身份认证:
- 进入腾讯云TokenHub的API Key管理页面
- 单击"创建API Key"
- 设置可访问范围时,如需使用特定模型请确保勾选对应模型
- 创建完成后复制并妥善保管API Key
3.3 配置模型文件
找到CodeBuddy Code的配置文件`models.json`,配置文件路径如下:
- Windows:`C:\Users\<用户名>\.codebuddy\models.json`
- macOS/Linux:`~/.codebuddy/models.json`
配置文件不存在时新建即可。以下是配置Hy3 preview模型的示例:
{
"models": [
{
"id": "hy3-preview",
"name": "hy3-preview",
"vendor": "Tencent Cloud",
"apiKey": "<USER_API_KEY>",
"url": "https://tokenhub.tencentmaas.com/v1"
}
],
"availableModels": ["hy3-preview"]
}
将`<USER_API_KEY>`替换为实际获取的API Key字符串。如`models.json`已存在,只需在`models`和`availableModels`中追加新模型配置即可。
3.4 启动CodeBuddy CLI
配置完成后执行以下命令启动:
codebuddy
首次启动时会弹出信任文件选择界面,询问是否信任当前工作目录下的项目文件:
- Yes, proceed(推荐):信任当前目录所有文件时选择此项,CodeBuddy Code才能读写项目文件、执行命令辅助开发
- No, exit:当前目录包含不信任或来源不明的代码时选择此项,工具将退出以确保安全
启动后会显示登录方式选择界面:
- Chinese Site:中国站用户,通过腾讯云中国站进行认证
- International Site:国际站用户,通过腾讯云国际站进行认证
- Enterprise Domain:专享版/私有化部署用户,需输入企业服务地址
- iOA:腾讯内部员工专用
选择登录方式后会自动打开浏览器完成认证。认证成功后返回命令行界面,输入`/model`即可进入模型选择列表,选择配置的模型开始使用。
四、CodeBuddy IDE使用指南
4.1 打开或创建项目
CodeBuddy IDE支持三种方式打开项目:新建文件夹、打开已有文件夹、克隆远程Git仓库。
4.2 Craft与Chat双模式
CodeBuddy IDE提供了侧栏对话功能,支持Craft和Chat两种模式:
Chat模式:通过自然语言进行技术对话,询问编程技术问题,支持多轮追问和上下文感知。适合日常开发中的技术咨询、代码解释、问题排查等场景。
Craft模式:不再是一个对话聊天机器人,而是一个具有"独立思考"和"自主执行"的编程伙伴。支持通过自然语言描述项目需求,Agent即可生成完整工程代码与多文件实现。支持Plan Mode,开启后Agent将根据项目需求进行任务拆解、制定开发计划并澄清需求。端到端覆盖需求→原型→代码,适合从零启动新项目。
4.3 多模型支持
CodeBuddy IDE内置了多种模型供用户切换,包括Default(Hunyuan)、DeepSeek-V3.1、DeepSeek-0324等。开发者可根据任务类型选择最适合的模型。
4.4 添加上下文
CodeBuddy IDE支持多种方式添加上下文以提升AI回答的准确性:
- 添加图片:通过Ctrl+V截图粘贴作为上下文
- 添加代码块:圈选代码后右键选择"Add To Chat"
- 添加文件或目录:在文件树中右键文件或目录,选择"Add File CodeBuddy"
- 添加终端报错:在底部面板中将问题或终端报错添加给CodeBuddy
- @引用上下文:使用@符号引用文件、文件夹、Git提交、知识库、Rules等
五、第三方开发集成与企业级对接
CodeBuddy专享版和企业版支持配置第三方开发集成,可通过开发第三方服务的方式对接其他身份管理平台。CodeBuddy旗舰版使用腾讯统一身份进行登录认证管理。
5.1 第三方服务开发
开发者需按照CodeBuddy提供的接口规范开发第三方组织架构服务。Custom Provider通过HTTP代理对接外部组织架构服务,组织服务需实现一组固定的REST接口,返回符合约定的数据结构。
配置项示例:
{
"name": "custom-org",
"base_url": "https://example.com",
"enterprise_id": "ent-xxx",
"timeout_seconds": 15,
"auth_header": "Authorization",
"auth_token": "token-value",
"bearer_token": true,
"extra_headers": {
"X-From": "org-service"
},
"account_id_header": "X-Account-Id",
"account_id_query": "account_id",
"success_code": 0,
"config_header": "X-Custom-Config"
}
字段说明:
- base_url:必填,自定义组织服务的根地址
- enterprise_id:默认作为查询参数附加
- timeout_seconds:请求超时,默认15秒
- auth_token:鉴权token,发送Authorization: Bearer <token>
- extra_headers:附加到所有请求的额外请求头
- account_id_header:将AccountID放入该请求头
- account_id_query:将AccountID作为该查询参数
- success_code:响应包装code成功值,默认0
5.2 启用第三方集成
进入企业域名后台`<企业id>.copilot.qq.com/admin`,选择"开放与集成"→"组织架构同步",单击任意第三方系统。根据页面提示输入上游系统名称、服务域名、token信息,配置关联规则(支持根据用户ID、邮箱、手机号匹配),选择完成后提交即可。
5.3 效果验证
配置完成后,在"开放与集成"→"组织架构同步"页面可以看到从第三方服务获取到的组织架构和人员信息。单击"手动关联"即可将成员从第三方服务同步至CodeBuddy。
六、部署对接与集成
6.1 EdgeOne Makers部署对接
CodeBuddy IDE支持集成EdgeOne Makers的快速部署能力,在开发过程中实现一键构建并部署至Makers。操作步骤:
- 在CodeBuddy IDE中单击Deploy按钮
- 选择EdgeOne Makers进行连接
- 单击Manage进入腾讯云,登录账号进行授权
建议配置EdgeOne Makers Rules(pages-llms.mdc),让AI懂得如何编写更符合Makers规范的代码。部署完成后可在CodeBuddy中查看部署情况、获取预览地址,也可访问腾讯云控制台进一步管理项目。
6.2 CloudBase后端集成
CodeBuddy集成了Supabase和腾讯云开发CloudBase后端服务,无需手动配置数据库、认证等后端服务即可获得可运行的后端环境。CodeBuddy IDE已内置集成CloudBase MCP,建议优先使用配置集成方式。
七、高级功能与自定义配置
7.1 MCP协议扩展
CodeBuddy支持MCP(Model Context Protocol)协议,可通过配置文件声明外部服务。例如声明数据库服务:
{
"services": {
"database": {
"command": "npx",
"args": ["@modelcontextprotocol/server-database", "mongodb://localhost:27017/mydb"]
}
}
}
利用CodeBuddy的MCP Server可一键生成Dockerfile并部署至腾讯云等平台。
7.2 自定义Rules规则
在Rules文件中可自定义项目规则,如项目规范、框架约定、库使用规则、编码安全要求等。这些规则在定义好后会在当前项目中生效,每次启动或重载项目时自动扫描并加载`.codeBuddy/rules`目录下的Rules文件。
最佳实践建议:规则应聚焦、可操作、范围清晰,每条规则保持在500行以内,可将大规则拆分为多个可组合的小规则。
7.3 代码质量保障
CodeBuddy提供智能审查与静态分析功能,可自动检测代码风格违规、潜在Bug(空指针、资源泄漏)、安全漏洞(SQL注入、XSS)等问题。例如代码中存在`SELECT * FROM users`时,CodeBuddy会提示"建议使用参数化查询防止SQL注入"。
单元测试生成功能:右键方法选择Generate Unit Test,自动生成JUnit/Mockito测试模板,覆盖边界条件与异常场景。
八、最佳实践
CodeBuddy的最佳实践可归纳为"精准需求、分步开发、严格审查、团队协同"。开发者需善用其智能补全与生成能力,同时保持对核心逻辑的掌控。
8.1 精准描述需求
向CodeBuddy提供功能需求、技术栈、输入/输出示例。例如:"用React + TypeScript开发一个动态表单生成器,支持字段类型扩展,要求代码包含校验逻辑和API调用示例。"避免模糊指令如"写一个表单"。
8.2 分步骤迭代
分阶段生成代码:
- 先生成核心逻辑(如表单校验函数)
- 逐步扩展UI组件和状态管理
- 最后整合API调用与错误处理
8.3 团队协作规范
在`.codebuddyrc`中定义团队规范:
{
"indentation": "2 spaces",
"naming_convention": "camelCase",
"prohibit": ["var", "eval"]
}
企业知识库集成:上传项目文档、API手册至CodeBuddy,通过自然语言查询获取上下文帮助。
九、常见问题
问:CodeBuddy支持哪些IDE?
CodeBuddy插件支持VS Code、JetBrains系列(IntelliJ IDEA、PyCharm等)、Visual Studio(17.6及以上版本)等主流IDE。
问:CodeBuddy目前是否免费?
目前CodeBuddy可以免费使用。具体计费政策请以腾讯云官方公告为准。
问:CodeBuddy支持哪些编程语言?
CodeBuddy理论上不限制任何类型的代码语言。支持前端(HTML、JavaScript、CSS、Vue、React等)、后端(Node.js、Python、Java、C#、Ruby、PHP等)、客户端(Java、Kotlin、Swift等)以及C++、Go、Rust、TypeScript等。
问:CodeBuddy CLI的模型配置文件在哪里?
Windows系统在`C:\Users\<用户名>\.codebuddy\models.json`,macOS/Linux系统在`~/.codebuddy/models.json`。
问:如何将CodeBuddy与企业身份管理系统对接?
CodeBuddy专享版和企业版支持第三方开发集成,需开发符合接口规范的组织架构服务,然后进入企业后台配置上游系统名称、服务域名、token信息及关联规则。旗舰版使用腾讯统一身份进行登录认证管理。
问:Craft模式和Chat模式有什么区别?
Chat模式是技术对话工具,适合日常技术咨询和代码解释。Craft模式是具有独立思考和自主执行的编程伙伴,可通过自然语言描述项目需求自动生成完整工程代码,支持Plan Mode进行任务拆解,适合从零启动新项目。




