命令

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

自定义命令让你指定在 TUI 中执行该命令时要运行的提示。

/my-command

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

---

# 创建命令文件#

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

创建 .opencode/command/test.md：

markdown
复制
1<!-- .opencode/command/test.md -->
2---
3description: 运行带覆盖率的测试
4agent: build
5model: anthropic/claude-3-5-sonnet-20241022
6---
7
8运行完整的测试套件并生成覆盖率报告，显示任何失败。
9专注于失败的测试并建议修复。

frontmatter 定义命令属性。内容成为模板。

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

"/test"

---

# 配置#

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

---

## JSON#

在 OpenCode 配置中使用 command 选项：

jsonc
复制
1{
2  "$schema": "https://opencode.ai/config.json",
3  "command": {
4    // 这成为命令的名称
5    "test": {
6      // 这是将发送给 LLM 的提示
7      "template": "运行完整的测试套件并生成覆盖率报告，显示任何失败。\n专注于失败的测试并建议修复。",
8      // 这在 TUI 中显示为描述
9      "description": "运行带覆盖率的测试",
10      "agent": "build",
11      "model": "anthropic/claude-3-5-sonnet-20241022"
12    }
13  }
14}

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

/test

---

## Markdown#

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

• 全局：~/.config/opencode/command/
• 项目级：.opencode/command/

markdown
复制
1<!-- ~/.config/opencode/command/test.md -->
2---
3description: 运行带覆盖率的测试
4agent: build
5model: anthropic/claude-3-5-sonnet-20241022
6---
7
8运行完整的测试套件并生成覆盖率报告，显示任何失败。
9专注于失败的测试并建议修复。

markdown 文件名成为命令名称。例如，test.md 让你可以运行：

/test

---

# 提示配置#

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

---

## 参数#

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

markdown
复制
1<!-- .opencode/command/component.md -->
2---
3description: 创建新组件
4---
5
6创建一个名为 $ARGUMENTS 的新 React 组件，支持 TypeScript。
7包含适当的类型和基本结构。

使用参数运行命令：

/component Button

$ARGUMENTS 将被替换为 Button。

你也可以使用位置参数访问单个参数：

• $1 - 第一个参数
• $2 - 第二个参数
• $3 - 第三个参数
• 以此类推…

例如：

markdown
复制
1<!-- .opencode/command/create-file.md -->
2---
3description: 创建带内容的新文件
4---
5
6在目录 $2 中创建一个名为 $1 的文件，
7包含以下内容：$3

运行命令：

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

这会替换：

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

---

## Shell 输出#

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

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

markdown
复制
1<!-- .opencode/command/analyze-coverage.md -->
2---
3description: 分析测试覆盖率
4---
5
6以下是当前的测试结果：
7!`npm test`
8
9根据这些结果，建议改进以提高覆盖率。

或者审查最近的更改：

markdown
复制
1<!-- .opencode/command/review-changes.md -->
2---
3description: 审查最近的更改
4---
5
6最近的 git 提交：
7!`git log --oneline -10`
8
9审查这些更改并建议任何改进。

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

---

## 文件引用#

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

markdown
复制
1<!-- .opencode/command/review-component.md -->
2---
3description: 审查组件
4---
5
6审查 @src/components/Button.tsx 中的组件。
7检查性能问题并建议改进。

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

---

# 选项#

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

---

## Template#

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

json
复制
1{
2  "command": {
3    "test": {
4      "template": "运行完整的测试套件并生成覆盖率报告，显示任何失败。\n专注于失败的测试并建议修复。"
5    }
6  }
7}

这是一个必需的配置选项。

---

## Description#

使用 description 选项提供命令功能的简要描述。

json
复制
1{
2  "command": {
3    "test": {
4      "description": "运行带覆盖率的测试"
5    }
6  }
7}

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

---

## Agent#

使用 agent 配置可选地指定哪个代理应执行此命令。如果这是一个子代理，命令将默认触发子代理调用。要禁用此行为，将 subtask 设置为 false。

json
复制
1{
2  "command": {
3    "review": {
4      "agent": "plan"
5    }
6  }
7}

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

---

## Subtask#

使用 subtask 布尔值强制命令触发子代理调用。如果你希望命令不污染主上下文，这很有用，并且将强制代理作为子代理运行，即使代理配置上的 mode 设置为 primary。

json
复制
1{
2  "command": {
3    "analyze": {
4      "subtask": true
5    }
6  }
7}

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

---

## Model#

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

json
复制
1{
2  "command": {
3    "analyze": {
4      "model": "anthropic/claude-3-5-sonnet-20241022"
5    }
6  }
7}

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

---

# 内置命令#

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

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

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