命令

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

自定义命令允许您指定在 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.

前置内容定义命令属性。其内容将成为模板。

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

"/test"

配置

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

JSON

使用 command 选项在您的 OpenCode 配置

{
  "$schema": "https://opencode.ac.cn/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/

---
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 选项定义了命令执行时将发送给大型语言模型（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 选项提供命令功能的简要描述。

{
  "command": {
    "test": {
      "description": "Run tests with coverage"
    }
  }
}

当您在 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；了解更多。

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