AgentHarness 课程

斜杠命令与快捷操作

4.4K字·12分钟·
常用命令、自定义命令、效率提升技巧

引言

在 CodeBuddy 的日常使用中,斜杠命令(Slash Commands)是你与智能体交互的最直接方式。通过输入 / 前缀,你可以快速触发各种预定义操作,大幅提升开发效率。本章将系统性地介绍所有内置斜杠命令、自定义命令的创建方法,以及高效使用斜杠命令的实战技巧。

掌握斜杠命令,就是掌握了 CodeBuddy 的"快捷键"——让你从繁琐的自然语言描述中解放出来,用最精简的指令完成最复杂的任务。


一、内置斜杠命令完整列表

1.1 项目管理类命令

命令功能说明使用场景
/init初始化项目配置新项目首次使用 CodeBuddy
/config查看或修改项目配置调整 CodeBuddy 行为参数
/rules管理项目规则文件添加/编辑/删除 Rules
/skills管理项目技能查看/启用/禁用 Skills
/memory管理记忆系统查看/添加/清除记忆
# 初始化项目配置
/init

# 查看当前项目配置
/config show

# 添加一条项目规则
/rules add "所有函数必须有 JSDoc 注释"

# 查看已加载的 Skills
/skills list

1.2 代码操作类命令

命令功能说明使用场景
/explain解释选中代码理解复杂逻辑
/refactor重构代码优化代码结构
/fix修复代码问题处理报错和警告
/test生成测试用例补充单元测试
/review代码审查提交前检查代码质量
/doc生成文档注释补充 API 文档
# 解释当前文件的复杂函数
/explain src/utils/parser.ts

# 重构选中的代码块
/refactor

# 为当前函数生成测试
/test

# 审查最近修改的文件
/review

1.3 Git 操作类命令

命令功能说明使用场景
/commit智能提交自动生成 commit message
/pr创建 Pull Request代码合并请求
/branch分支管理创建/切换/合并分支
/diff查看差异对比代码变更
/log查看提交历史追溯代码变更记录
# 智能提交
/commit

# 创建 Pull Request
/pr create "feat: 用户登录功能"

# 查看当前变更
/diff

1.4 知识查询类命令

命令功能说明使用场景
/search搜索项目代码快速定位代码位置
/ask提问项目相关问题了解项目架构和设计
/learn学习项目代码深入理解特定模块
/help查看帮助信息了解可用命令
# 搜索项目中的 API 路由
/search "router.post"

# 询问项目的认证机制
/ask "项目使用了什么认证方案?"

# 查看所有可用命令
/help

二、自定义命令

2.1 通过 Skills 创建自定义命令

Skills 是扩展斜杠命令最灵活的方式,将复杂的多步骤操作封装为一个命令。

# .codebuddy/skills/deploy-staging.yaml
name: deploy-staging
description: 部署到预发布环境
command: /deploy-stg
trigger: slash_command
steps:
  - name: 运行测试
    action: run_tests
    args:
      coverage: true
  - name: 构建项目
    action: build
    args:
      mode: production
  - name: 部署到 staging
    action: deploy
    args:
      environment: staging
  - name: 通知团队
    action: notify
    args:
      channel: "#deployments"
      message: "已部署到 staging 环境"

2.2 通过 Hooks 创建自动触发命令

Hooks 可以在特定事件触发时自动执行命令,实现"隐形"的自动化。

{
  "hooks": {
    "preCommit": {
      "command": "npm run lint && npm test",
      "description": "提交前自动检查"
    },
    "postCommit": {
      "command": "echo '提交成功!'",
      "description": "提交后通知"
    }
  }
}

2.3 命令别名配置

{
  "aliases": {
    "dc": "/deploy-stg",
    "rc": "/review --strict",
    "tc": "/test --coverage",
    "gc": "/commit",
    "gp": "/pr create"
  }
}

三、效率提升技巧

3.1 命令组合使用

# 组合1:完整的代码提交流程
/test && /review && /commit

# 组合2:代码质量检查
/explain src/ && /refactor --check && /test

# 组合3:项目初始化流程
/init && /config set framework react && /rules add "使用 TypeScript"

3.2 快捷键速查表

快捷键功能说明
Tab命令补全输入 / 后自动补全命令
历史命令浏览之前的命令
Ctrl+C取消当前操作中断正在执行的命令
Ctrl+L清屏清理终端输出
Esc退出命令模式取消斜杠命令输入
Enter执行命令确认并执行当前命令

3.3 上下文感知命令

CodeBuddy 的斜杠命令会根据当前上下文智能调整行为:

  • 在 TypeScript 文件中执行 /refactor → 会建议 TypeScript 特有的重构方式
  • 在测试文件中执行 /test → 会生成符合当前测试框架的用例
  • 在 Git 仓库中执行 /commit → 会分析当前 staged 文件生成 commit message

四、实战案例:日常开发工作流

场景一:开发新功能的完整流程

# 1. 创建功能分支
/branch create feat/user-auth

# 2. 了解现有认证架构
/ask "当前项目的认证方案是怎样的?"

# 3. 编写代码后,解释关键逻辑
/explain src/auth/middleware.ts

# 4. 生成测试用例
/test --coverage src/auth/

# 5. 代码审查
/review --strict

# 6. 提交代码
/commit

# 7. 创建 PR
/pr create "feat: 添加用户认证中间件"

场景二:紧急修复 Bug

# 1. 定位问题代码
/search "TypeError"

# 2. 修复并测试
/fix
/test

# 3. 快速提交
/commit --hotfix

# 4. 部署验证
/deploy-stg

五、常见陷阱与最佳实践

常见错误

  1. 命令参数缺失/commit 不带 message,可能导致生成不准确的提交信息
  2. 上下文不匹配:在非 Git 仓库中执行 /commit 会报错
  3. 命令顺序错误:先 /review/test,应先测试再审查
  4. 忽略命令帮助:使用 /help <命令> 可以查看详细用法

最佳实践

  1. 善用命令补全:输入 / 后按 Tab 查看所有可用命令
  2. 利用历史命令:用 快速重复之前的命令
  3. 组合使用命令:将常用流程封装为 Skills
  4. 定期更新规则:通过 /rules 命令维护项目规范

总结

斜杠命令是 CodeBuddy 的"快捷入口",掌握它们能让你的开发效率提升数倍。关键要点:

  1. 四大类命令:项目管理、代码操作、Git 操作、知识查询,覆盖开发全流程
  2. 自定义扩展:通过 Skills 和 Hooks 创建专属命令
  3. 组合使用:将多个命令串联实现复杂自动化
  4. 上下文感知:命令会根据当前环境智能调整行为
  5. 快捷键辅助:善用 Tab 补全和历史命令提升效率

下一章我们将深入探索 CodeBuddy 的记忆系统,了解它如何在跨会话间复用知识。