命令

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

自定义命令允许你指定在 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": "运行完整的测试套件并生成覆盖率报告，显示任何失败项。\n专注于失败的测试并建议修复方案。",
      // 这将作为 TUI 中的描述显示
      "description": "运行带有覆盖率的测试",
      "agent": "build",
      "model": "anthropic/claude-3-5-sonnet-20241022"
    }
  }
}

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

/test

提示词配置

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

参数

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

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

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

运行带有参数的命令：

/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 输出

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

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

---
description: 分析测试覆盖率
---

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

根据这些结果，提出提高覆盖率的改进建议。

或者查看最近的更改：

---
description: 查看最近的更改
---

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

查看这些更改并提出任何改进建议。

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

文件引用

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

---
description: 审查组件
---

审查 @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；了解更多。

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

Markdown

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

全局: ~/.config/opencode/command/
每个项目: .opencode/command/

---
description: 运行带有覆盖率的测试
agent: build
model: anthropic/claude-3-5-sonnet-20241022
---

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

Markdown 文件名即为命令名称。例如，test.md 允许你运行：

/test