第 1 卷

IDE插件CLIWorkBuddyWorkBuddy 小程序WorkBuddy 移动端企业版

Menu快速导航

快速入门指南

欢迎使用 CodeBuddy Code！这份指南将帮助您在 5分钟内上手，体验自然语言驱动的编程助手。

🎯开始之前

系统要求

Node.js：版本 18.20 或更高

操作系统: macOS、Linux 或 Windows

验证环境

bash

# 检查 Node.js 版本 node --version# 应显示 v18.0.0 或更高

# 检查 npm 版本 npm --version

⚡极速安装

npm 全局安装

bash

npm install -g @tencent-ai/codebuddy-code

原生安装器（Beta）

• Beta 功能：原生安装器目前处于 Beta 阶段。我们推荐您尝试使用，以获得更快速、独立的

安装体验。

原生安装器提供独立的 CodeBuddy 安装，无需 Node.js环境。

bash

# macOS/Linux curl -fsSL https://copilot.tencent.com/cli/install.sh | bash

powershell

# Windows irm https://copilot.tencent.com/cli/install.ps1 | iex

优势：

• 无需 Node.js依赖
• 安装和启动速度更快

验证安装

bash

codebuddy --version

🔐登录认证

首次使用 CodeBuddy Code时，您需要完成登录认证。启动后会显示登录方式选择界面：

Select login method:

• Log in via Chinese Site

Log in via International Site Log in via Enterprise Domain Log in via iOA (Tencent only)

登录方式说明

登录方式适用场景说明

通过腾讯云国内站 (copilot.tencent.com) 进行认证，支持国 Chinese Site国内用户内主流模型

International通过腾讯云国际站 (codebuddy.ai) 进行认证，支持海外主流海外用户 Site模型

使用 ↑↓ 键选择登录方式，按 Enter 确认后会自动打开浏览器完成认证。

🚀首次体验

1.进入项目目录

bash

cd /path/to/your/project

2.启动交互模式

bash

codebuddy

您将看到欢迎界面：

提示：如果您希望 CodeBuddy Code始终使用特定语言回复（如简体中文），可以在启动后运行 /config 命令设置 Language选项。

🤖 CodeBuddy Code v1.0.0 💡 输入 /help 查看可用命令 📝 开始对话，让 AI 成为您的编程伙伴

>

3.初始化项目上下文（强烈推荐）

在正式开始对话之前，强烈建议先使用 /init 命令初始化项目上下文：

> /init

为什么 /init 如此重要？

📊 效果提升：

• 理解更准确：预先构建项目知识图谱，AI 能更准确理解代码结构和业务逻辑
• 响应更快速：避免重复扫描文件，后续对话响应速度显著提升
• 建议更精准：基于全局视图提供更符合项目架构的建议
• 减少误判：了解项目依赖关系，避免提出不兼容的修改方案

💰 成本优化：

• Token 消耗更少：一次性建立上下文，避免每次对话都重新分析
• 减少重复请求：预加载关键信息，减少 30-50% 的上下文 Token开销