自定义指令(Custom Commands)
自定义指令功能允许您将常用的提示词(Prompts)、固定流程和项目约定封装为可复用的命令。在 Agent 对话框中输入/ 后,您可以浏览、筛选并调用当前可用的指令,用更少的输入完成重复任务。
无论您是频繁执行代码审查、生成测试用例,还是需要快速查询项目规范、整理提交说明或发起标准化任务,自定义指令都能把高频操作沉淀为稳定、可复用的工作入口。
指令类型与作用范围
| 特性 | 用户级指令(User Commands) | 项目级指令(Project Commands) |
|---|---|---|
| 作用范围 | 对当前用户的所有项目生效 | 仅在当前项目根目录及其子目录中生效 |
| 存储路径 | - macOS / Linux: /home/<username>/.qoder/commands/ 或 /Users/<username>/.qoder/commands/- Windows: C:\Users\<username>\.qoder\commands\ | <项目根目录>/.qoder/commands/ |
| 目录组织 | 支持在 commands 目录下按文件夹分类整理 | 支持在 commands 目录下按文件夹分类整理 |
| 适用场景 | 通用开发任务,例如: • 审查代码 • 生成单元测试 | 项目专属任务,例如: • 检查本项目 API 规范 • 校验配置文件格式 |
| 共享方式 | 仅限当前用户使用 | 可通过 Git 等版本控制系统与团队成员共享 |
注意:用户级指令不支持跨设备同步,您可以手动迁移配置文件。 注意:创建项目级指令前,请先打开目标项目;若同时存在同名的用户级指令和项目级指令,列表中会附带作用范围标识,便于区分。
创建自定义指令
-
打开指令管理界面
- 方法一:进入 Qoder 设置中的指令页面,点击 “添加” 按钮
- 方法二:在对话框中输入
/,点击底部的 “添加指令” 快捷入口(如界面显示该入口)
-
在顶部搜索栏中输入一个唯一指令名称(如
gen-test),然后按 回车。- 建议使用简短、清晰、便于记忆的名称
- 建议避免与已有指令重名,减少检索和选择时的混淆
-
指令名称需遵循以下规则:
- 仅支持小写字母、数字、连字符(
-)和下划线(_) - 名称不能为空
- 名称长度建议控制在 100 个字符以内
- 同一作用范围下不能与现有指令重名
- 仅支持小写字母、数字、连字符(
-
选择指令类型:
- 用户级:适用于所有项目的通用命令
- 项目级:仅在当前项目中可用;若未打开项目,则无法创建
- 在编辑区域填写指令说明和正文内容。建议在开头用简短描述说明用途,正文中写入完整提示词或操作步骤。
-
保存后,返回会话,在对话框内输入
/即可看到新创建的指令。
注意:若指令正文为空,或仅保留默认占位内容,该指令不会出现在可用列表中。
指令更新与列表刷新
当您新增、修改或删除指令文件后,指令列表会按最新状态刷新,方便您继续在会话中使用最新版本。 常见刷新场景包括:- 新增指令后,列表中会出现新的可选项
- 修改指令内容后,后续选择时会使用更新后的内容
- 删除指令后,列表中对应项目会消失
- 按用途将指令放入不同子目录,便于整理
- 为指令填写清晰描述,方便在列表中搜索和识别
- 定期清理不再使用的旧指令,减少重复和混淆
示例指令
/code-inspect
/code-inspect
/security-check
/security-check
/create-pr
/create-pr
/project-test
/project-test
/gen-agents-md
/gen-agents-md