快速入门指南
欢迎使用 CodeBuddy Code!这份指南将帮助您在 5 分钟内上手,体验自然语言驱动的编程助手。
🎯 开始之前
系统要求
- Node.js: 版本 18.0 或更高
- 操作系统: macOS、Linux 或 Windows
验证环境
bash
# 检查 Node.js 版本
node --version # 应显示 v18.0.0 或更高
# 检查 npm 版本
npm --version⚡ 极速安装
全局安装(推荐)
bash
npm install -g @tencent-ai/codebuddy-code验证安装
bash
codebuddy --version🚀 首次体验
1. 进入项目目录
bash
cd /path/to/your/project2. 启动交互模式
bash
codebuddy您将看到欢迎界面:
🤖 CodeBuddy Code v1.0.0
💡 输入 /help 查看可用命令
📝 开始对话,让 AI 成为您的编程伙伴
>3. 尝试第一个对话
> 帮我分析这个项目的结构CodeBuddy 会自动扫描您的项目文件,并提供详细的结构分析。
💡 核心使用模式
交互式对话模式
最自然的使用方式,适合探索性开发:
bash
codebuddy典型对话示例:
> 我想给这个 React 组件添加一个加载状态
> 帮我重构这个函数,让它更易读
> 这段代码有什么潜在的性能问题?
> 为这个 API 接口写单元测试单次命令模式
适合脚本化和自动化场景:
bash
# 直接提问
codebuddy -p "优化这个 SQL 查询的性能"
# 管道输入
cat error.log | codebuddy -p "分析这些错误日志"
# 文件分析(需要授权时必须添加 --dangerously-skip-permissions)
codebuddy -p "审查 src/utils.js 的代码质量" --dangerously-skip-permissions重要提示:使用
-p/--print参数进行单次执行时,如果操作需要访问文件、执行命令等授权操作,必须添加--dangerously-skip-permissions参数。
项目级操作
处理复杂的跨文件任务:
bash
# 项目重构(需要文件操作授权)
codebuddy -p "将所有组件从 class 组件迁移到函数组件" --dangerously-skip-permissions
# 代码规范(需要文件读取授权)
codebuddy -p "检查整个项目的 TypeScript 类型定义" --dangerously-skip-permissions
# 测试覆盖(需要文件操作授权)
codebuddy -p "为 services 目录下的所有文件添加单元测试" --dangerously-skip-permissions快捷键
| 快捷键 | 功能 |
|---|---|
↑/↓ | 浏览命令历史 |
Tab | 命令自动补全 |
Ctrl+C | 退出程序 |
🎓 进阶学习
恭喜您完成快速入门!接下来推荐阅读:
💬 获取帮助
遇到问题?我们随时为您提供支持:
现在开始,让 AI 成为您的编程伙伴! 🚀