快速开始

首次体验

1. 进入项目目录

cd /path/to/your/project

2. 启动交互模式

codebuddycbc

您将看到欢迎界面：

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

>

说明：

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

3. 初始化项目上下文

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

> /init

为什么 /init 如此重要？

效果提升：

理解更准确：预先构建项目知识图谱，AI 能更准确理解代码结构和业务逻辑

响应更快速：避免重复扫描文件，后续对话响应速度显著提升

建议更精准：基于全局视图提供更符合项目架构的建议

减少误判：了解项目依赖关系，避免提出不兼容的修改方案

成本优化：

token 消耗更少：一次性建立上下文，避免每次对话都重新分析

减少重复请求：预加载关键信息，减少 30-50% 的上下文 Token 开销

更高效的对话：每轮对话携带更少的冗余信息，整体成本更低

最佳实践：

# 第一次使用项目时
> /init

# 项目结构发生重大变化时（如添加新模块、重构等）
> /clear  # 开启全新对话
> /init   # 重新初始化

4. 尝试第一个对话

> 帮我分析这个项目的结构

CodeBuddy 会自动扫描您的项目文件，并提供详细的结构分析。

核心使用模式

交互式对话模式

最自然的使用方式，适合探索性开发：

codebuddy

典型对话示例：

> 我想给这个 React 组件添加一个加载状态> 帮我重构这个函数，让它更易读> 这段代码有什么潜在的性能问题？> 为这个 API 接口写单元测试

单次命令模式

适合脚本化和自动化场景：

# 直接提问
codebuddy -p "优化这个 SQL 查询的性能"

# 管道输入
cat error.log | codebuddy -p "分析这些错误日志"

# 文件分析（需要授权时必须添加 -y 或 --dangerously-skip-permissions）
codebuddy -p "审查 src/utils.js 的代码质量" -y

重要提示：

使用 -p/--print 参数进行单次执行时，如果操作需要访问文件、执行命令等授权操作，必须添加 -y （或 --dangerously-skip-permissions) 参数。

项目级操作

处理复杂的跨文件任务：

# 项目重构（需要文件操作授权）
codebuddy -p "将所有组件从 class 组件迁移到函数组件" -y

# 代码规范（需要文件读取授权）
codebuddy -p "检查整个项目的 TypeScript 类型定义" -y

# 测试覆盖（需要文件操作授权）
codebuddy -p "为 services 目录下的所有文件添加单元测试" -y

快捷键

基础导航

权限和模式

编辑功能

面板操作

专用功能

当终端显示“Thinking”指示时，可用 Ctrl+O 打开完整推理内容,再按 Ctrl+O 退出。