CodeBuddy 斜杠命令（配置）

一、内置斜杠命令 （Built-in Slash Commands)

这些命令用于管理你的 CodeBuddy Code 会话。以下是当前的支持情况：

二、自定义斜杠命令 （Custom Slash Commands)

这是 CodeBuddy Code 最核心的功能之一。你可以将常用的提示(Prompts)、脚本和工作流封装成可复用的自定义命令，从而极大地提升效率。

注意：说明：

注意：如果你需要创建 AI 自动识别并调用的专业能力模板，而不是用户手动触发的命令，请查看 Skills 文档。

三、创建自定义命令

自定义命令通过在特定目录中创建 .md (Markdown) 文件来定义。

1. 项目级命令：在你的项目根目录下创建 .codebuddy/commands/ 文件夹。此处的命令对所有项目协作者可用。

2. 个人全局命令：在你的用户主目录下创建 ~/.codebuddy/commands/ 文件夹。此处的命令在你所有的项目中都可用。

创建一个命令，只需在上述任一目录中添加一个 .md 文件即可。例如,test.md 文件会自动注册为 /test 命令。

四、子目录中的命令命名

你可以在 commands/ 目录下创建子目录来组织你的命令。子目录中的命令会使用冒号分隔的层级命名结构：

·commands/test.md → /test

·commands/frontend/build.md → /frontend:build

·commands/backend/deploy/staging.md → /backend:deploy:staging

这种命名方式让你可以：

·按功能模块组织命令（如 frontend、backend、database 等）

·创建层级化的命令结构

·避免命名冲突，提高命令的可维护性

五、Frontmatter 与元数据

你可以在 Markdown 文件的顶部使用 YAML Frontmatter 来定义命令的元数据。

—description: "为我的项目运行单元测试并报告结果。"argument-hint: "[test-file]"allowed-tools: Bash(npm run:*)model: gemini-3.1-pro—请为我运行 `npm run test — $1` 命令，并总结测试结果。如果未提供测试文件，则运行所有测试。

支持的元数据字段：

注意：如果指定了 allowed-tools,命令只能使用列出的工具。使用 Bash(git:*) 表示允许所有 git 命令,Bash(git add:*) 表示仅允许 git add 命令。

六、使用参数

你的自定义命令可以接收参数，就像 Shell 脚本一样。有两种方式来处理参数：

七、方式一：位置参数 （$1, $2, $3, …)

按位置访问单个参数。这种方式适合需要在命令的不同部分使用不同参数的情况。

示例： review-pr.md

—description: "代码审查"argument-hint: "[pr-number] [priority] [assignee]"—请审查 PR #$1，优先级为 $2，并分配给 $3 进行最终确认。重点检查以下方面：- 代码风格和实践教程- 性能影响- 安全问题- 测试覆盖率

·调用 `/review-pr 456 high alice` 时：

·`$1` = `456`

·`$2` = `high`

·`$3` = `alice`

八、方式二：捕获所有参数 （$ARGUMENTS)

一次性捕获所有参数。这种方式适合参数个数不确定的情况。

—description: "修复代码问题"argument-hint: "[issue-number] [details…]"—请修复 issue #$ARGUMENTS，遵循我们的编码标准。按照以下步骤：1. 理解问题2. 定位根本原因3. 实现修复4. 添加测试5. 验证修复效果

·调用 /fix-issue 123 high-priority refactor-auth-module 时：

·$ARGUMENTS = 123 high-priority refactor-auth-module

参数解析规则：参数通过空格分隔，支持单引号和双引号来处理含有空格的参数。例如 /greet "Hello World" 会将 "Hello World" 作为单个参数传递。

九、执行 Shell 命令

在命令的任何一行前面加上 ! 前缀,命令用反引号包围,该行就会被当作 Shell 命令执行,其输出 (stdout) 会被捕获并注入到上下文中，供 AI 后续分析。

注意：重要提示：

注意：使用 Shell 命令执行时，必须在 allowed-tools frontmatter 中包含 Bash 工具，否则命令无法执行。

示例： status.md

—description: "显示当前的 git 仓库状态并进行分析。"allowed-tools: Bash(git status:*), Bash(git diff:*)—当前 git 状态：!`git status`当前分支的变更：!`git diff HEAD`请基于上面的输出，为我总结当前分支的状况。

更多示例：commit.md

—description: "创建一个 git 提交。"allowed-tools: Bash(git add:*), Bash(git status:*), Bash(git diff:*), Bash(git commit:*)argument-hint: "[message]"—## 当前状态- Git 状态： !`git status`- 分段变更： !`git diff –cached`- 最近提交： !`git log –oneline -5`## 任务基于上面的信息，使用提供的提交消息创建一个 git 提交：$1如果没有提供消息，使用默认的描述性消息。

十、文件引用

在命令中使用 @ 前缀来包含文件内容。系统会自动读取文件并将其内容注入到 AI 上下文中。

示例

—description: "代码审查"—请审查以下文件：@src/utils/helpers.js@src/utils/validators.js找出潜在的性能问题和代码风格问题。

十二、1. 描述要清晰明确

编写清晰的 description 和 argument-hint，帮助用户和 AI 理解命令的用途：

—description: "执行安全审计，扫描代码中的潜在漏洞和安全问题"argument-hint: "[files…] [–severity high|medium|low]"—

十三、2. 使用细粒度的工具权限

通过 allowed-tools 限制命令可以使用的工具和操作：

—allowed-tools: Bash(npm test:*), Bash(git diff:*), Readdescription: "运行测试并与主分支比较"—

这比允许所有工具更安全和高效。

十四、3. 组织命令到子目录

为大量命令创建逻辑分组：

.codebuddy/commands/├── frontend/│ ├── build.md│ ├── test.md│ └── lint.md├── backend/│ ├── migrate.md│ ├── deploy.md│ └── logs.md└── git/ ├── commit.md ├── review.md └── release.md

调用方式：

·/frontend:build

·/backend:deploy

·/git:commit "message"

十五、4. 提供有用的上下文

在 Shell 命令执行前插入有用的信息：

—description: "分析代码覆盖率"allowed-tools: Bash(npm run:*)—## 当前状态项目根目录： !`pwd`当前分支： !`git rev-parse –abbrev-ref HEAD`## 任务请运行测试并生成覆盖率报告：!`npm run coverage`基于上述结果，为我总结代码覆盖率情况。

十六、5. 处理可选参数

使用条件逻辑处理可选参数：

—description: "运行特定或全部测试"argument-hint: "[test-file]"allowed-tools: Bash(npm run:*)—$1 为空时将运行所有测试，否则运行指定的测试文件。命令： !`npm run test — $1`

十七、6. 指定特定模型

为需要特定能力的命令指定模型：

—description: "代码复杂性分析"model: gemini-3.1-pro—分析这段代码的复杂性…

十九、场景1：代码审查工作流

创建 .codebuddy/commands/code-review.md：

—description: "对指定文件进行代码审查"argument-hint: "[file-paths…]"allowed-tools: Read—请对以下文件进行代码审查，关注代码质量、可维护性和安全性：@$ARGUMENTS审查要点：1. 代码风格和命名约定2. 函数复杂度3. 错误处理4. 性能考虑5. 安全隐患

20、场景2：自动化部署

创建 .codebuddy/commands/deploy.md：

—description: "部署应用到指定环境"argument-hint: "[environment] [version]"allowed-tools: Bash(npm run:*), Bash(git:*)—## 部署流程当前版本： !`cat package.json | grep version`最近的标签： !`git describe –tags –abbrev=0`目标环境： $1目标版本： $2准备部署 $2 到 $1 环境…

21、场景3：项目诊断

创建 .codebuddy/commands/diagnose.md：

—description: "诊断项目状态和环境"allowed-tools: Bash(npm list:*), Bash(git:*), Bash(node –version:*)—## 项目诊断报告Node 版本： !`node –version`NPM 版本： !`npm –version`Git 状态： !`git status –short`依赖信息： !`npm list –depth=0`基于上述信息，为我总结项目状态并提出建议。

23、命令不执行

1. 检查命令文件位置

·项目命令：.codebuddy/commands/*.md

·全局命令：~/.codebuddy/commands/*.md

2. 检查 frontmatter 格式

·确保 YAML 语法正确

·如果指定了 allowed-tools，确保工具格式正确

3. 检查 Shell 命令权限

·如果使用了 ! 前缀执行命令,必须在 allowed-tools 中包含 Bash 工具

24、参数未正确替换

确保使用了正确的参数格式：

·$1, $2, $3 用于位置参数

·$ARGUMENTS 用于所有参数

·在 frontmatter 中正确指定了 argument-hint

25、文件引用不工作

1. 使用绝对路径或相对于项目根目录的相对路径

2. 确保路径中没有空格，或使用引号围绕完整路径

3. 检查文件是否存在和可读

26、技巧与窍门

·版本控制：将项目命令提交到 Git，团队成员可以共享

·权限控制：使用 allowed-tools 确保命令只使用必要的权限

·性能：避免在 Shell 命令中执行耗时操作

·清晰性：使用明确的命名和描述，帮助团队理解命令的用途