🚀 快速开始
⚠️ 安装前准备
在安装 CodeBuddy CLI 之前,请确保您的系统已满足以下要求:
- 已安装 Node.js 16+ 或 Python 3.7+
- 具备基本的命令行操作能力
- 稳定的网络连接(用于下载依赖)
✅ 一键安装命令
如果您已满足上述要求,可以直接使用以下命令安装:
# 使用 npm 安装(推荐)
npm install -g @codebuddy/cli
# 或使用 pip 安装
pip install codebuddy-cli
📋 详细安装步骤
1
安装 Node.js 或 Python
Windows 系统需要先安装运行环境:
# 方法一:安装 Node.js(推荐)
# 访问 https://nodejs.org 下载最新 LTS 版本
# 安装时勾选 "Add to PATH"
# 方法二:安装 Python
# 访问 https://python.org 下载 Python 3.8+
# 安装时勾选 "Add Python to PATH"
验证安装:
# Node.js 验证
node --version
npm --version
# Python 验证
python --version
pip --version
2
安装 CodeBuddy CLI
# 方法一:使用 npm 安装(推荐)
npm install -g @codebuddy/cli
# 方法二:使用 pip 安装
pip install codebuddy-cli
权限问题
如果遇到权限错误,请以管理员身份运行命令提示符。
3
配置 CodeBuddy
# 初始化配置
codebuddy init
# 配置 API 密钥(如果需要)
codebuddy config set api_key your_api_key_here
1
安装 Node.js 或 Python
macOS 用户可以使用 Homebrew 安装:
# 安装 Node.js(推荐)
brew install node
# 或安装 Python
brew install python@3.9
验证安装:
# Node.js 验证
node --version
npm --version
# Python 验证
python3 --version
pip3 --version
2
安装 CodeBuddy CLI
# 使用 npm 安装(推荐)
npm install -g @codebuddy/cli
# 或使用 pip3 安装
pip3 install codebuddy-cli
如果遇到权限问题,使用 sudo:
sudo npm install -g @codebuddy/cli
3
配置 CodeBuddy
# 初始化配置
codebuddy init
# 配置 API 密钥(如果需要)
codebuddy config set api_key your_api_key_here
1
安装 Node.js 或 Python
使用包管理器安装运行环境:
# Ubuntu/Debian - 安装 Node.js(推荐)
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejs
# 或安装 Python
sudo apt update
sudo apt install python3 python3-pip
2
安装 CodeBuddy CLI
# 使用 npm 安装(推荐)
sudo npm install -g @codebuddy/cli
# 或使用 pip3 安装
pip3 install codebuddy-cli
3
配置 CodeBuddy
# 初始化配置
codebuddy init
# 配置 API 密钥(如果需要)
codebuddy config set api_key your_api_key_here
✅ 验证安装
测试 CodeBuddy CLI
运行以下命令验证安装是否成功:
# 检查版本
codebuddy --version
# 查看帮助信息
codebuddy --help
# 测试代码生成
codebuddy generate "创建一个简单的 Python Hello World 程序"
成功标志
如果您看到 CodeBuddy 的版本信息或生成的代码,说明安装配置成功!
🛠️ 常用功能介绍
代码生成
使用 CodeBuddy 生成各种代码:
# 生成 Python 代码
codebuddy generate "创建一个计算斐波那契数列的函数" --language python
# 生成 JavaScript 代码
codebuddy generate "创建一个简单的 Express.js 服务器" --language javascript
# 生成 HTML 页面
codebuddy generate "创建一个响应式的登录页面" --language html
代码优化
# 优化现有代码
codebuddy optimize ./src/app.js
# 分析代码性能
codebuddy analyze ./src/ --performance
项目模板
# 创建 React 项目
codebuddy create react my-app
# 创建 Node.js 项目
codebuddy create nodejs my-api
# 创建 Python 项目
codebuddy create python my-script
❓ 常见问题解答
安装时出现权限错误怎么办?
+
Windows:以管理员身份运行命令提示符
macOS/Linux:使用 sudo 命令或配置用户环境
# 配置 npm 用户安装
npm config set prefix ~/.npm-global
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
CodeBuddy CLI 有哪些常用命令?
+
# 生成代码
codebuddy generate "描述" --language 语言
# 创建项目
codebuddy create 类型 项目名
# 优化代码
codebuddy optimize 文件路径
# 分析代码
codebuddy analyze 目录路径
# 查看配置
codebuddy config list
如何更新 CodeBuddy CLI?
+
# 使用 npm 更新
npm update -g @codebuddy/cli
# 使用 pip 更新
pip install --upgrade codebuddy-cli
CodeBuddy CLI 支持哪些编程语言?
+
CodeBuddy CLI 支持多种主流编程语言:
- Python
- JavaScript/TypeScript
- Java
- C/C++
- Go
- Rust
- HTML/CSS
- SQL
- Shell 脚本
如何配置自定义模板?
+
# 创建自定义模板
codebuddy template create my-template
# 编辑模板文件
codebuddy template edit my-template
# 使用自定义模板
codebuddy create my-template project-name
模板文件通常位于:~/.codebuddy/templates/