跳到主要内容

CodeBuddy 安装

本页基于 CodeBuddy CLI 官方安装指南整理,按你的环境选择合适方式即可。

安装方式

使用包管理器安装

Node.js 包管理器

前置要求:Node.js 18.20 或更高版本。

任选一种包管理器执行:

npm install -g @tencent-ai/codebuddy-code
pnpm add -g @tencent-ai/codebuddy-code
yarn global add @tencent-ai/codebuddy-code
bun install -g @tencent-ai/codebuddy-code

Homebrew(macOS/Linux)

无需 Node.js,直接安装。

两步安装:

# 添加 tap
brew tap Tencent-CodeBuddy/tap

# 安装工具
brew install codebuddy-code

单命令安装:

brew install Tencent-CodeBuddy/tap/codebuddy-code

Brewfile:

tap "Tencent-CodeBuddy/tap"
brew "codebuddy-code"

验证安装

安装完成后,运行:

codebuddy --version

使用原生二进制安装(Beta)

⚠️ Beta 测试阶段

原生二进制安装当前仍在 Beta 测试中,功能持续完善。如遇问题,可在 Issues 页面反馈,或联系技术支持([email protected])。

Issues 页面:https://cnb.cool/codebuddy/codebuddy-code/-/issues

特性说明

原生二进制相比 npm 版本具备以下特点:

  • 单一可执行文件,无需额外依赖
  • 无需 Node.js 运行时
  • 自动更新机制更完善

支持平台

  • macOS(Apple Silicon M1/M2/M3 或 Intel x86_64)
  • Linux(arm64 或 x86_64)
  • Windows(x86_64)

从 npm 版本迁移

如已通过 npm 安装,可执行:

codebuddy install

全新安装

macOS / Linux:

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

Windows(PowerShell):

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

验证安装

安装脚本会下载最新版本并配置环境变量。完成后运行:

codebuddy --version

如果命令不可用,请手动将安装路径加入 PATH

macOS / Linux:

export PATH="$HOME/.local/bin:$PATH"

# 为了永久生效,建议添加到 shell 配置文件:
# Bash: ~/.bashrc 或 ~/.bash_profile
# Zsh: ~/.zshrc

Windows(PowerShell):

# 将以下路径添加到用户环境变量:
# %USERPROFILE%\AppData\Local\codebuddy\bin

配置目录

CodeBuddy Code 默认配置目录:

  • macOS / Linux:~/.codebuddy
  • Windows:%USERPROFILE%\.codebuddy

配置目录内容

~/.codebuddy/
├── settings.json # 用户设置
├── mcp.json # MCP 服务器配置
├── .mcp.json # MCP 服务器配置(备选位置)
└── skills/ # 用户自定义 Skills

自定义配置目录

可通过环境变量 CODEBUDDY_CONFIG_DIR 指定配置目录:

export CODEBUDDY_CONFIG_DIR="$HOME/.my-codebuddy-config"

适用于以下场景:

  • 多个 CodeBuddy 实例需要独立配置
  • 企业环境需要统一管理配置目录

参考资料