中文
文档
命令

命令

为重复性任务创建自定义命令。

自定义命令让你指定一个提示词,当该命令在 TUI 中执行时运行。

/my-command

自定义命令是对内置命令(如 /init/undo/redo/share/help)的补充。了解更多


创建命令文件

commands/ 目录中创建 markdown 文件以定义自定义命令。

创建 .opencode/commands/test.md

.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 选项:

opencode.jsonc
{
  "$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 中运行此命令:

/test

Markdown

你也可以使用 markdown 文件来定义命令。将它们放在:

  • 全局:~/.config/opencode/commands/
  • 按项目:.opencode/commands/
~/.config/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.

markdown 文件名会成为命令名。例如,test.md 让你可以运行:

/test

提示词配置

自定义命令的提示词支持若干特殊占位符和语法。


参数

使用 $ARGUMENTS 占位符向命令传递参数。

.opencode/commands/component.md
---
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 - 第三个参数
  • 以此类推……

例如:

.opencode/commands/create-file.md
---
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 输出

使用 !commandbash 命令的输出注入到你的提示词中。

例如,要创建一个分析测试覆盖率的自定义命令:

.opencode/commands/analyze-coverage.md
---
description: Analyze test coverage
---
 
Here are the current test results:
!`npm test`
 
Based on these results, suggest improvements to increase coverage.

或者审查最近的变更:

.opencode/commands/review-changes.md
---
description: Review recent changes
---
 
Recent git commits:
!`git log --oneline -10`
 
Review these changes and suggest any improvements.

命令在你项目的根目录中运行,其输出会成为提示词的一部分。


文件引用

使用 @ 后跟文件名将文件包含进你的命令中。

.opencode/commands/review-component.md
---
description: Review component
---
 
Review the component in @src/components/Button.tsx.
Check for performance issues and suggest improvements.

文件内容会自动被包含进提示词中。


选项

让我们详细了解各项配置选项。


Template

template 选项定义命令执行时将发送给 LLM 的提示词。

opencode.json
{
  "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 选项提供一段关于该命令功能的简短描述。

opencode.json
{
  "command": {
    "test": {
      "description": "Run tests with coverage"
    }
  }
}

当你输入命令时,这会作为描述显示在 TUI 中。


Agent

使用 agent 配置可选地指定应由哪个 agent 执行此命令。 如果它是一个 subagent,该命令默认会触发一次 subagent 调用。 要禁用此行为,请将 subtask 设为 false

opencode.json
{
  "command": {
    "review": {
      "agent": "plan"
    }
  }
}

这是一个可选的配置选项。如果未指定,默认使用你当前的 agent。


Subtask

使用 subtask 布尔值强制命令触发一次 subagent 调用。 当你希望命令不污染你的主上下文时,这很有用;它会强制 agent 作为 subagent 运行, 即使在 agent 配置中 mode 被设为 primary 也是如此。

opencode.json
{
  "command": {
    "analyze": {
      "subtask": true
    }
  }
}

这是一个可选的配置选项。


Model

使用 model 配置覆盖此命令的默认模型。

opencode.json
{
  "command": {
    "analyze": {
      "model": "anthropic/claude-3-5-sonnet-20241022"
    }
  }
}

这是一个可选的配置选项。


内置

opencode 包含若干内置命令,如 /init/undo/redo/share/help了解更多

注意: 自定义命令可以覆盖内置命令。

如果你定义了一个同名的自定义命令,它会覆盖对应的内置命令。