概述
内置了 7 个高效的斜杠指令(Slash Commands),专注于代码开发全流程,帮助开发者快速完成项目初始化、代码审查、测试生成、问题修复等核心开发任务。
使用方式:
在对话框中手动输入 /,系统会自动弹出斜杠指令列表供你选择。列表中包含:
内置斜杠指令:系统预设的 7 个常用指令
自定义斜杠指令:用户创建的个性化指令
你可以从列表中选择所需的指令,然后根据提示输入相关参数。
注意:
仅在对话输入框为空时才会出现并可选择。
每条消息只能包含一个 /command,不可组合多个。
创建自定义指令创建的是项目级别的指令。(可兼容 CodeBuddy Code 的用户级别的指令,~/.codebuddy/commands/, IDE 后续版本会增加创建用户级别自定义指令的入口。)
内置斜杠指令详解
/init - 初始化项目并生成 CODEBUDDY.md
功能描述:快速初始化项目结构,并自动生成 CODEBUDDY.md 配置文件。
适用场景:
创建新项目时快速搭建项目骨架
为已有项目添加 CodeBuddy 配置
标准化项目文档和配置管理
使用示例:
/init
/summarize - 压缩对话上下文
功能描述:在对话变得过长时,通过 AI 驱动的总结机制来压缩较长的聊天上下文,以确保对话的高效进行。
适用场景:
对话内容过长时手动触发,用于管理上下文
在不丢失重要信息的情况下继续高效工作
需要在同一会话中继续对话,但上下文窗口即将达到限制
当对话增长并超出模型的上下文窗口限制时,为新的对话腾出空间
使用建议: 为保证模型效果并控制 credit 消耗,建议将上下文窗口保持在 100K 以下。当上下文接近或超过此限制时,建议使用 /summarize 命令压缩对话。
工作原理: 当对话增长并超出模型的上下文窗口限制时,系统会自动或手动对较旧的消息进行总结:
超出限制时:最新的消息会被截断,因为超出了上下文窗口
总结处理后:旧的消息被压缩成"总结内容",从而为新的对话留出空间
使用方式:
手动触发:在聊天中输入命令 /summarize
自动触发:当对话超出上下文窗口限制时自动进行总结
注意: 模型输出的内容只是摘要展示,后台实际保留的压缩信息比输出的摘要更详细、更结构化,确保后续对话能够延续之前的上下文。
使用示例:
/summarize
/rules - 自动生成规则文件
功能描述:根据项目需求自动生成代码规范、lint 规则、开发指南等规则文件。
适用场景:
项目初期制定编码规范
团队协作统一代码风格
生成 ESLint、Prettier 等配置
创建代码审查 checklist
自动化质量管理
生成规则类型:
代码风格规则
命名规范
文件组织规则
Git 提交规范
项目最佳实践
使用示例:
/rules 生成 TypeScript 代码规范 /rules 创建 Git commit 规范 /rules package.json 根据项目依赖生成 ESLint 配置
/explain - 解释代码工作原理
功能描述:深入分析代码逻辑,让 CodeBuddy 用通俗易懂的语言解释代码的工作原理和设计思路。
适用场景:
理解复杂的代码逻辑
学习新的代码库
代码审查时快速理解实现
技术分享和文档编写
解释内容:
代码整体架构
核心算法逻辑
数据流转过程
关键设计决策
使用示例:
/explain test.py /explain src/utils/algorithm.ts 解释这个算法的实现原理 /explain UserService.java 说明这个服务类的职责
/fix - 修复代码问题
功能描述:自动识别并修复代码中的 bug、错误和问题。
适用场景:
快速修复编译错误
解决运行时异常
修复 lint 错误
处理类型错误
解决逻辑 bug
修复能力:
语法错误
类型错误
逻辑错误
性能问题
安全漏洞
使用示例:
/fix main.py 修复 Python 语法错误 /fix components/Button.tsx 解决 TypeScript 类型错误 /fix login.js 修复登录逻辑中的空指针异常
/tests - 生成单元测试
功能描述:为代码自动生成全面的单元测试用例,提高代码测试覆盖率。
适用场景:
为新功能快速生成测试用例
提升项目测试覆盖率
补充遗漏的边界条件测试
TDD(测试驱动开发)实践
生成内容:
正常场景测试
边界条件测试
异常情况测试
使用示例:
/tests utils.js 为工具函数生成测试用例 /tests UserController.java 生成完整的单元测试 /tests src/api/auth.ts 为认证模块添加测试覆盖
/cr - 代码审查
功能描述:对代码进行全面审查,检查代码质量、潜在问题、性能优化点和最佳实践遵循情况。
适用场景:
Pull Request 提交前的代码自查
代码重构前的质量评估
学习他人代码的最佳实践
识别潜在的 bug 和安全隐患
审查维度:
代码规范性
性能问题
安全漏洞
可维护性
使用示例:
/cr app.py 审查 Python 代码质量 /cr src/components 审查整个组件目录 /cr database.js 重点检查 SQL 注入等安全问题
自定义斜杠指令
除了内置的斜杠指令外,CodeBuddy 还支持创建自定义斜杠指令。你可以根据自己的工作流需求,将常用的提示词、工作流程或特定任务封装成可复用的自定义命令。
创建自定义指令
在输入 / 后的指令列表中,选择"自定义斜杠指令"选项,即可进入自定义指令的创建界面。你可以:
定义指令名称和描述
设置触发提示词或执行脚本
配置指令参数和输入格式
指定适用的工作目录或文件类型
使用场景
封装团队特定的代码生成模板
创建项目专属的快速操作命令
定义标准化的代码审查流程
自动化重复性的开发任务
通过自定义斜杠指令,你可以显著提升开发效率,将个人或团队的最佳实践固化为可复用的命令。
紫米美村