Commands

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

自定义命令允许您指定在 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 中运行这个命令：

/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

使用 $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 Output

使用 !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.

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

File Reference

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

---
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 应执行此命令。如果是 Subagents 该命令将默认触发子代理调用。要取消此行为，则将 subtask 设置为 false。

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

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

subtask

使用 subtask 布尔值强制命令触发 Subagents 调用。如果您希望命令不污染您的主要上下文并且将强制代理充当子代理，那么这非常有用，即使 mode 在 Agent 配置上设置为 primary。

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

这是一个可选配置选项。

model

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

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

这是一个可选配置选项。

内置

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

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