命令
为重复性任务创建自定义命令。
自定义命令允许你指定在 TUI 中执行该命令时要运行的提示词。
/my-command自定义命令是内置命令(如 /init、/undo、/redo、/share、/help)的补充。了解更多。
创建命令文件
在 commands/ 目录中创建 markdown 文件来定义自定义命令。
创建 .opencode/commands/test.md:
---
description: Run tests with coverage
agent: build
model: anthropic/claude-3-5-sonnet-20241022
---
Run the full test suite with coverage report and show any failures.
Focus on the failing tests and suggest fixes.frontmatter 定义命令属性。内容成为模板。
输入 / 后跟命令名称来使用命令。
/test配置
你可以通过 OpenCode 配置或在 commands/ 目录中创建 markdown 文件来添加自定义命令。
JSON
在 OpenCode 配置中使用 command 选项:
{
"$schema": "https://opencode.ai/config.json",
"command": {
// This becomes the name of the command
"test": {
// This is the prompt that will be sent to the LLM
"template": "Run the full test suite with coverage report and show any failures.\nFocus on the failing tests and suggest fixes.",
// This is shown as the description in the TUI
"description": "Run tests with coverage",
"agent": "build",
"model": "anthropic/claude-3-5-sonnet-20241022"
}
}
}现在你可以在 TUI 中运行此命令:
/testMarkdown
你也可以使用 markdown 文件定义命令。将它们放在:
- 全局:
~/.config/opencode/commands/ - 项目级:
.opencode/commands/
---
description: Run tests with coverage
agent: build
model: anthropic/claude-3-5-sonnet-20241022
---
Run the full test suite with coverage report and show any failures.
Focus on the failing tests and suggest fixes.markdown 文件名成为命令名称。例如,test.md 允许你运行:
/test提示词配置
自定义命令的提示词支持多种特殊占位符和语法。
参数
使用 $ARGUMENTS 占位符向命令传递参数。
---
description: Create a new component
---
Create a new React component named $ARGUMENTS with TypeScript support.
Include proper typing and basic structure.带参数运行命令:
/component Button$ARGUMENTS 将被替换为 Button。
你也可以使用位置参数访问单个参数:
$1- 第一个参数$2- 第二个参数$3- 第三个参数- 以此类推...
例如:
---
description: Create a new file with content
---
Create a file named $1 in the directory $2
with the following content: $3运行命令:
/create-file config.json src "{ \"key\": \"value\" }"这将替换:
$1为config.json$2为src$3为{ "key": "value" }
Shell 输出
使用 !command 将 bash 命令输出注入到提示词中。
例如,创建一个分析测试覆盖率的自定义命令:
---
description: Analyze test coverage
---
Here are the current test results:
!`npm test`
Based on these results, suggest improvements to increase coverage.或者审查最近的更改:
---
description: Review recent changes
---
Recent git commits:
!`git log --oneline -10`
Review these changes and suggest any improvements.命令在项目根目录中运行,其输出成为提示词的一部分。
文件引用
使用 @ 后跟文件名在命令中包含文件。
---
description: Review component
---
Review the component in @src/components/Button.tsx.
Check for performance issues and suggest improvements.文件内容会自动包含在提示词中。
选项
让我们详细了解配置选项。
Template
template 选项定义执行命令时发送给 LLM 的提示词。
{
"command": {
"test": {
"template": "Run the full test suite with coverage report and show any failures.\nFocus on the failing tests and suggest fixes."
}
}
}这是必需的配置选项。
Description
使用 description 选项提供命令功能的简要描述。
{
"command": {
"test": {
"description": "Run tests with coverage"
}
}
}当你在 TUI 中输入命令时,这会显示为描述。
Agent
使用 agent 配置可选地指定哪个 agent 应执行此命令。如果这是一个 subagent,命令将默认触发 subagent 调用。要禁用此行为,将 subtask 设置为 false。
{
"command": {
"review": {
"agent": "plan"
}
}
}这是可选的配置选项。如果未指定,默认为当前 agent。
Subtask
使用 subtask 布尔值强制命令触发 subagent 调用。如果你希望命令不污染主上下文,这很有用,它将强制 agent 作为 subagent 运行,即使 agent 配置中的 mode 设置为 primary。
{
"command": {
"analyze": {
"subtask": true
}
}
}这是可选的配置选项。
Model
使用 model 配置覆盖此命令的默认模型。
{
"command": {
"analyze": {
"model": "anthropic/claude-3-5-sonnet-20241022"
}
}
}这是可选的配置选项。
内置命令
OpenCode 包含多个内置命令,如 /init、/undo、/redo、/share、/help;了解更多。
注意
自定义命令可以覆盖内置命令。
如果你定义了同名的自定义命令,它将覆盖内置命令。