命令

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

自定义命令允许您指定在 TUI 中执行该命令时要运行的提示词。

/my-command

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

创建命令文件

在 command/ 目录中创建 Markdown 文件来定义自定义命令。

创建 .opencode/command/test.md：

---
description: 运行测试并生成覆盖率报告
agent: build
model: anthropic/claude-3-5-sonnet-20241022
---

运行完整的测试套件并生成覆盖率报告，显示任何失败。
重点关注失败的测试并建议修复方案。

Frontmatter 定义了命令属性。内容部分成为模板。

通过键入 / 后跟命令名称来使用该命令。

"/test"

配置

您可以通过 OpenCode 配置或在 command/ 目录中创建 Markdown 文件来添加自定义命令。

JSON

在您的 OpenCode 配置中使用 command 选项：

{
  "$schema": "https://opencode.ai/config.json",
  "command": {
    // 这将作为命令的名称
    "test": {
      // 这是将发送给 LLM 的提示词
      "template": "Run the full test suite with coverage report and show any failures.\nFocus on the failing tests and suggest fixes.",
      // 这将在 TUI 中显示为描述
      "description": "Run tests with coverage",
      "agent": "build",
      "model": "anthropic/claude-3-5-sonnet-20241022"
    }
  }
}

现在您可以在 TUI 中运行此命令：

/test

Markdown

您也可以使用 markdown 文件来定义命令。将它们放置在：

全局：~/.config/opencode/command/
项目内：.opencode/command/

---
description: 运行测试并生成覆盖率报告
agent: build
model: anthropic/claude-3-5-sonnet-20241022
---

运行完整的测试套件并生成覆盖率报告，显示任何失败。
重点关注失败的测试并建议修复方案。

markdown 文件的名称将成为命令名。例如，test.md 允许您运行：

/test

提示词配置

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

参数

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

---
description: 创建一个新组件
---

创建一个名为 $ARGUMENTS 的 React 组件，支持 TypeScript。
包含适当的类型定义和基本结构。

带参数运行命令：

/component Button

$ARGUMENTS 将被替换为 Button。

您也可以使用位置参数访问单个参数：

$1 - 第一个参数
$2 - 第二个参数
$3 - 第三个参数
以此类推…

例如：

---
description: 创建包含内容的新文件
---

在目录 $2 中创建一个名为 $1 的文件
内容如下：$3

运行命令：

/create-file config.json src "{ \"key\": \"value\" }"

这将替换：

$1 为 config.json
$2 为 src
$3 为 { "key": "value" }

Shell 输出

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

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

---
description: Analyze test coverage
---

以下是当前的测试结果：
!`npm test`

基于这些结果，建议提高覆盖率的改进措施。

或者审查最近的更改：

---
description: Review recent changes
---

最近的 git 提交：
!`git log --oneline -10`

审查这些更改并建议任何改进。

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

文件引用

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

---
description: Review component
---

审查 @src/components/Button.tsx 中的组件。
检查性能问题并提出改进建议。

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

选项

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

模板

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

{
  "command": {
    "test": {
      "template": "运行完整的测试套件并生成覆盖率报告，显示任何失败。\n重点关注失败的测试并建议修复方案。"
    }
  }
}

这是一个必需的配置选项。

描述

使用 description 选项提供命令功能的简要描述。

{
  "command": {
    "test": {
      "description": "运行测试并生成覆盖率报告"
    }
  }
}

当你在 TUI 中输入命令时，此描述会显示为命令的说明。

代理

使用 agent 配置来可选地指定应由哪个代理执行此命令。如果这是一个子代理，默认情况下该命令将触发子代理调用。要禁用此行为，请将 subtask 设置为 false。

{
  "command": {
    "review": {
      "agent": "plan"
    }
  }
}

这是一个可选的配置项。如果未指定，则默认为您当前的代理。

子任务

使用 subtask 布尔值来强制命令触发子代理调用。如果您希望命令不污染您的主上下文，并且强制代理作为子代理运行，这将非常有用，即使在代理配置中将 mode 设置为 primary 也是如此。

{
  "command": {
    "analyze": {
      "subtask": true
    }
  }
}

这是一个可选的配置项。

模型

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

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

这是一个可选的配置项。

内置命令

opencode 包含多个内置命令，如 /init、/undo、/redo、/share、/help；了解更多。

如果您定义了一个同名的自定义命令，它将覆盖内置命令。