CodeBuddy CLI

CodeBuddy CLI

CodeBuddy CLI官网

环境要求

在开始安装前，请确认你的系统满足以下最低要求（以 npm 安装方式为准）：

依赖	最低版本	说明
Node.js	≥ 18.20	运行环境，建议使用 LTS 版本
npm	≥ 8	随 Node.js 一同安装
Git	≥ 2.20（推荐）	版本控制集成
操作系统	macOS / Linux / Windows	Windows 建议使用 WSL2 获得更好体验

检查当前环境

打开终端（Windows 下可用 PowerShell 或 CMD），执行：

# 查看 Node.js 版本
node --version

# 查看 npm 版本
npm --version

# 查看 Git 版本（可选）
git --version

安装CLI

npm install -g @tencent-ai/codebuddy-code
#验证安装
codebuddy --version

打开 http://127.0.0.1:44158/ ,可以配置模型等

登录认证

首次执行 codebuddy 命令，会自动弹出登录方式选择界面。使用 ↑ ↓ 键选择，Enter 确认，随后浏览器打开完成认证。

登录方式	适用场景	认证方式
Chinese Site	国内用户	微信扫码登录
International Site	海外用户	GitHub / Google 账号登录
Enterprise Domain	企业专享版 / 私有化部署	输入企业提供的服务地址
iOA	腾讯内部员工	通过 iOA 零信任系统认证

💡 选择建议：国内用户选 Chinese Site（微信扫码），海外用户选 International Site。海外版支持的模型更丰富。

初始化配置

登录成功后，建议执行以下两步配置：

项目初始化 /init

在项目目录下启动 codebuddy 后，输入：

/init

这会预先构建项目的知识图谱，让 AI 更准确地理解你的代码结构，同时降低 Token 消耗。强烈推荐！

个性化配置 /config

输入 /config 进入交互式配置界面，可以调整：

配置项	建议
Auto-compact	建议设为 false（关闭自动压缩上下文）
Model	选择你偏好的 AI 模型

---

快速上手

三步体验 CodeBuddy Code ：

# 第一步：进入你的项目目录
cd /path/to/your/project

# 第二步：启动交互模式
codebuddy

# 第三步：在交互界面中直接用自然语言提问
# 例如：帮我分析这个项目的结构
#       写一个用户登录接口
#       帮我重构这个函数

常用命令模式

# 交互对话模式
codebuddy

# 单次命令模式（适合脚本化）
codebuddy -p "解释这段代码的作用"

# 需要自动确认文件操作时
codebuddy -y -p "按照 ESLint 规范修复所有问题"