通过 / 调用常用工作流程,或把重复使用的任务要求保存为自定义指令。
经常需要整理交付说明、检查变更或按固定格式输出结果时,可以把这些要求保存为指令(Command)。在任务输入框中用
在 设置 → 扩展管理 → 指令 中,可以查看插件提供的指令名称、说明和来源。如果需要某个插件的指令,先在 扩展 → 插件 中安装并启用对应插件。
在任务输入框中输入
先决定指令在哪些任务中使用,再将 Markdown 文件保存到相应目录。目录不存在时可以自行创建。
文件名去掉
自定义指令保存在自己的 Markdown 文件中。要调整要求,编辑对应文件并保存,再在新任务中重新打开
/ 选择指令,再补充本次要处理的内容,就能复用同一套要求。
指令可以来自已安装的插件,也可以是自己编写的 Markdown 文件。
查找可用指令
在 设置 → 扩展管理 → 指令 中,可以查看插件提供的指令名称、说明和来源。如果需要某个插件的指令,先在 扩展 → 插件 中安装并启用对应插件。
在任务输入框中输入 /,继续输入名称或关键词,查找标为指令的候选项。项目内的自定义指令需要在该项目对应的工作区中使用;跨项目复用的要求可以保存为用户级指令。
在任务中调用指令
- 打开任务;使用项目指令时,先确认任务选中了对应工作区。
- 输入
/和名称或关键词,用上下方向键选择候选项,按Enter或Tab添加。 - 在指令条目后补充本次的任务目标、处理范围和所需材料,再发送消息。
- 查看执行结果,确认是否满足指令中的要求;需要调整时,在同一任务中继续说明。
/pipeline,选择 gitlab:pipeline-status,再说明要查询的项目和流水线。涉及外部服务时,还需要完成相应连接器的认证。
如果只是选中了指令,但回复没有开始处理任务,请补充明确的执行要求,例如“请按此指令整理当前任务的交付说明”。
创建自定义指令
先决定指令在哪些任务中使用,再将 Markdown 文件保存到相应目录。目录不存在时可以自行创建。
| 使用范围 | 保存目录 | 适合内容 |
|---|---|---|
| 用户级 | ~/.qoder/commands/ | 自己在不同工作区重复使用的工作要求 |
| 项目级 | <项目目录>/.qoder/commands/ | 仅在该项目工作区中使用的约定或流程 |
~ 表示当前用户的主目录。
例如,创建 handoff.md,保存以下内容:
.md 后就是指令名称;description 是候选列表中的说明,正文是希望复用的任务要求。使用简短、易辨认的名称,便于在输入框中查找。
保存后,打开新任务并输入 /handoff,选择指令,再补充“请整理本次任务的交付说明,保留未完成项”。需要引用其他资料时,可以用 @ 添加上下文,具体入口见发送消息。
修改或移除指令
自定义指令保存在自己的 Markdown 文件中。要调整要求,编辑对应文件并保存,再在新任务中重新打开 / 列表确认内容。要移除指令,将文件移出 commands 目录,再确认列表中已不再显示。
插件提供的指令通过所属插件管理。需要调整可用状态时,前往插件管理处理对应插件。
找不到指令时
- 插件指令:确认对应插件已安装并启用,再按名称或关键词查找。名称可能包含插件前缀,例如
gitlab:pipeline-status。 - 项目指令:确认任务使用了对应项目的工作区,文件位于该项目的
.qoder/commands/中。 - 用户指令:确认文件位于上表中的用户级目录,使用
.md扩展名,并包含要执行的正文。
/;仍未找到时,在新任务中再次确认。
