File size: 9,626 Bytes
89a2873 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 | ---
title: Команды
description: Создавайте собственные команды для повторяющихся задач.
---
Пользовательские команды позволяют указать подсказку, которую вы хотите запускать при выполнении этой команды в TUI.
```bash frame="none"
/my-command
```
Пользовательские команды дополняют встроенные команды, такие как `/init`, `/undo`, `/redo`, `/share`, `/help`. [Подробнее](/docs/tui#commands).
---
## Создание файлов команд
Создайте Markdown файлы в каталоге `commands/` для определения пользовательских команд.
Создайте `.opencode/commands/test.md`:
```md title=".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) определяет свойства команды. Содержимое становится шаблоном.
Используйте команду, набрав `/`, а затем имя команды.
```bash frame="none"
"/test"
```
---
## Настройка
Вы можете добавлять собственные команды через конфигурацию opencode или создав файлы Markdown в каталоге `commands/`.
---
### JSON
Используйте опцию `command` в вашем opencode [config](/docs/config):
```json title="opencode.jsonc" {4-12}
{
"$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 frame="none"
/test
```
---
### Markdown
Вы также можете определять команды, используя Markdown файлы. Поместите их в:
- Глобальный: `~/.config/opencode/commands/`
- Для каждого проекта: `.opencode/commands/`
```markdown title="~/.config/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.
```
Имя Markdown файла становится именем команды. Например, `test.md` позволяет
вам запустить:
```bash frame="none"
/test
```
---
## Настройка промпта
Подсказки для пользовательских команд поддерживают несколько специальных заполнителей и синтаксиса.
---
### Аргументы
Передавайте аргументы командам, используя заполнитель `$ARGUMENTS`.
```md title=".opencode/commands/component.md"
---
description: Create a new component
---
Create a new React component named $ARGUMENTS with TypeScript support.
Include proper typing and basic structure.
```
Запустите команду с аргументами:
```bash frame="none"
/component Button
```
И `$ARGUMENTS` будет заменен на `Button`.
Вы также можете получить доступ к отдельным аргументам, используя позиционные параметры:
- `$1` — первый аргумент
- `$2` — Второй аргумент
- `$3` — Третий аргумент
- И так далее...
Например:
```md title=".opencode/commands/create-file.md"
---
description: Create a new file with content
---
Create a file named $1 in the directory $2
with the following content: $3
```
Запустите команду:
```bash frame="none"
/create-file config.json src "{ \"key\": \"value\" }"
```
Это заменяет:
- `$1` с `config.json`
- `$2` с `src`
- `$3` с `{ "key": "value" }`
---
### Вывод shell
Используйте _!`command`_, чтобы ввести вывод команды bash](/docs/tui#bash-commands) в приглашение.
Например, чтобы создать пользовательскую команду, которая анализирует тестовое покрытие:
```md title=".opencode/commands/analyze-coverage.md"
---
description: Analyze test coverage
---
Here are the current test results:
!`npm test`
Based on these results, suggest improvements to increase coverage.
```
Или просмотреть последние изменения:
```md title=".opencode/commands/review-changes.md"
---
description: Review recent changes
---
Recent git commits:
!`git log --oneline -10`
Review these changes and suggest any improvements.
```
Команды выполняются в корневом каталоге вашего проекта, и их вывод становится частью приглашения.
---
### Ссылки на файлы
Включите файлы в свою команду, используя `@`, за которым следует имя файла.
```md title=".opencode/commands/review-component.md"
---
description: Review component
---
Review the component in @src/components/Button.tsx.
Check for performance issues and suggest improvements.
```
Содержимое файла автоматически включается в приглашение.
---
## Параметры
Рассмотрим варианты конфигурации подробнее.
---
### Template
Параметр `template` определяет приглашение, которое будет отправлено в LLM при выполнении команды.
```json title="opencode.json"
{
"command": {
"test": {
"template": "Run the full test suite with coverage report and show any failures.\nFocus on the failing tests and suggest fixes."
}
}
}
```
Это **обязательный** параметр конфигурации.
---
### Описание
Используйте опцию `description`, чтобы предоставить краткое описание того, что делает команда.
```json title="opencode.json"
{
"command": {
"test": {
"description": "Run tests with coverage"
}
}
}
```
Это отображается в виде описания в TUI при вводе команды.
---
### Агент
Используйте конфигурацию `agent`, чтобы дополнительно указать, какой [агент](/docs/agents) должен выполнить эту команду.
Если это [subagent](/docs/agents/#subagents), команда по умолчанию инициирует вызов субагента.
Чтобы отключить это поведение, установите для `subtask` значение `false`.
```json title="opencode.json"
{
"command": {
"review": {
"agent": "plan"
}
}
}
```
Это **необязательный** параметр конфигурации. Если не указано, по умолчанию используется текущий агент.
---
### Subtask
Используйте логическое значение `subtask`, чтобы заставить команду инициировать вызов [subagent](/docs/agents/#subagents).
Это полезно, если вы хотите, чтобы команда не загрязняла ваш основной контекст и **заставляла** агента действовать как субагент.
даже если для `mode` установлено значение `primary` в конфигурации [agent](/docs/agents).
```json title="opencode.json"
{
"command": {
"analyze": {
"subtask": true
}
}
}
```
Это **необязательный** параметр конфигурации.
---
### Модель
Используйте конфигурацию `model`, чтобы переопределить модель по умолчанию для этой команды.
```json title="opencode.json"
{
"command": {
"analyze": {
"model": "anthropic/claude-3-5-sonnet-20241022"
}
}
}
```
Это **необязательный** параметр конфигурации.
---
## Встроенные команды
opencode включает несколько встроенных команд, таких как `/init`, `/undo`, `/redo`, `/share`, `/help`; [подробнее](/docs/tui#commands).
:::note
Пользовательские команды могут переопределять встроенные команды.
:::
Если вы определите пользовательскую команду с тем же именем, она переопределит встроенную команду.
|