命令 - OpenCode Docs | OpenCode Tutorial

自定义命令允许您指定一个提示，当该命令在 TUI 中执行时，您希望运行该提示。

bash

/my-command

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

##创建命令文件

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

创建 .opencode/commands/test.md:

bash

---
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 定义命令属性。内容成为模板。

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

bash

"/test"

##配置

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

###JSON

在您的 OpenCode config 中使用 command 选项：

bash

{
  "$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 中运行此命令：

bash

/test

###Markdown

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

全局：~/.config/opencode/commands/
每个项目：.opencode/commands/

bash

---
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 允许您运行：

bash

/test

##提示配置

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

###参数

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

bash

---
description: Create a new component
---

Create a new React component named $ARGUMENTS with TypeScript support.
Include proper typing and basic structure.

使用参数运行命令：

bash

/component Button

$ARGUMENTS 将被替换为 Button。

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

$1 - 第一个参数
$2 - 第二个参数
$3 - 第三个参数
等等...

例如：

bash

---
description: Create a new file with content
---

Create a file named $1 in the directory $2
with the following content: $3

运行命令：

bash

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

这将替换：

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

###Shell 输出

使用 !command 将 bash command 输出注入到您的提示中。

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

bash

---
description: Analyze test coverage
---

Here are the current test results:
!`npm test`

Based on these results, suggest improvements to increase coverage.

或者查看最近的更改：

bash

---
description: Review recent changes
---

Recent git commits:
!`git log --oneline -10`

Review these changes and suggest any improvements.

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

###文件引用

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

bash

---
description: Review component
---

Review the component in @src/components/Button.tsx.
Check for performance issues and suggest improvements.

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

##选项

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

###Template

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

bash

{
  "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 选项来提供命令作用的简要描述。

bash

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

当您在 TUI 中键入命令时，这会显示为描述。

###Agent

使用 agent 配置来选择性地指定哪个 agent 应该执行此命令。如果这是一个 subagent，则该命令默认会触发一个 subagent 调用。要禁用此行为，请将 subtask 设置为 false。

bash

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

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

###Subtask

使用 subtask 布尔值来强制命令触发 subagent 调用。如果您希望该命令不污染您的主要上下文，这将非常有用，并且即使 agent 配置上的 mode 设置为 primary，也会强制该 agent 充当 subagent。

bash

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

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

###Model

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

bash

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

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

##内置

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

Note

📝 注意

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

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