命令

為重複任務創建自定義命令。

自定義命令允許您指定在 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 佔位符將參數傳遞給命令。

---
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等內置命令；了解更多。

如果您定義同名的自定義命令，它將覆蓋內置命令。