File size: 7,302 Bytes
0dbc9de | 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: Comandos
description: Cree comandos personalizados para tareas repetitivas.
---
Los comandos personalizados le permiten especificar un mensaje que desea ejecutar cuando ese comando se ejecuta en TUI.
```bash frame="none"
/my-command
```
Los comandos personalizados se suman a los comandos integrados como `/init`, `/undo`, `/redo`, `/share`, `/help`. [M谩s informaci贸n](/docs/tui#commands).
---
## Crear archivos de comando
Cree archivos de Markdown en el directorio `commands/` para definir comandos personalizados.
Crear `.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.
```
El frontmatter define las propiedades del comando. El contenido se convierte en la plantilla.
Utilice el comando escribiendo `/` seguido del nombre del comando.
```bash frame="none"
"/test"
```
---
## Configuraci贸n
Puede agregar comandos personalizados a trav茅s de la configuraci贸n OpenCode o creando archivos de Markdown en el directorio `commands/`.
---
### JSON
Utilice la opci贸n `command` en su 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"
}
}
}
```
Ahora puedes ejecutar este comando en TUI:
```bash frame="none"
/test
```
---
### Markdown
Tambi茅n puede definir comandos utilizando archivos de Markdown. Col贸calos en:
- Global: `~/.config/opencode/commands/`
- Por proyecto: `.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.
```
El nombre del archivo de Markdown se convierte en el nombre del comando. Por ejemplo, `test.md` permite
que lo ejecutes:
```bash frame="none"
/test
```
---
## Configuraci贸n de indicaciones
Las indicaciones para los comandos personalizados admiten varios marcadores de posici贸n y sintaxis especiales.
---
### Argumentos
Pase argumentos a comandos usando el marcador de posici贸n `$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.
```
Ejecute el comando con argumentos:
```bash frame="none"
/component Button
```
Y `$ARGUMENTS` ser谩 reemplazado por `Button`.
Tambi茅n puede acceder a argumentos individuales utilizando par谩metros posicionales:
- `$1` - Primer argumento
- `$2` - Segundo argumento
- `$3` - Tercer argumento
- Etc茅tera...
Por ejemplo:
```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
```
Ejecute el comando:
```bash frame="none"
/create-file config.json src "{ \"key\": \"value\" }"
```
Esto reemplaza:
- `$1` con `config.json`
- `$2` con `src`
- `$3` con `{ "key": "value" }`
---
### Salida del shell
Utilice _!`command`_ para inyectar la salida de [comando bash](/docs/tui#bash-commands) en su mensaje.
Por ejemplo, para crear un comando personalizado que analice la cobertura de la prueba:
```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.
```
O para revisar cambios recientes:
```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.
```
Los comandos se ejecutan en el directorio ra铆z de su proyecto y su salida pasa a formar parte del mensaje.
---
### Referencias de archivos
Incluya archivos en su comando usando `@` seguido del nombre del archivo.
```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.
```
El contenido del archivo se incluye autom谩ticamente en el mensaje.
---
## Opciones
Veamos las opciones de configuraci贸n en detalle.
---
### Plantilla
La opci贸n `template` define el mensaje que se enviar谩 al LLM cuando se ejecute el comando.
```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."
}
}
}
```
Esta es una opci贸n de configuraci贸n **obligatoria**.
---
### Descripci贸n
Utilice la opci贸n `description` para proporcionar una breve descripci贸n de lo que hace el comando.
```json title="opencode.json"
{
"command": {
"test": {
"description": "Run tests with coverage"
}
}
}
```
Esto se muestra como descripci贸n en TUI cuando escribe el comando.
---
### Agente
Utilice la configuraci贸n `agent` para especificar opcionalmente qu茅 [agente](/docs/agents) debe ejecutar este comando.
Si se trata de un [subagente](/docs/agents/#subagents), el comando activar谩 una invocaci贸n de subagente de forma predeterminada.
Para desactivar este comportamiento, establezca `subtask` en `false`.
```json title="opencode.json"
{
"command": {
"review": {
"agent": "plan"
}
}
}
```
Esta es una opci贸n de configuraci贸n **opcional**. Si no se especifica, el valor predeterminado es su agente actual.
---
### Subtarea
Utilice el booleano `subtask` para forzar que el comando active una invocaci贸n de [subagente](/docs/agents/#subagents).
Esto es 煤til si desea que el comando no contamine su contexto principal y **obligue** al agente a actuar como subagente.
incluso si `mode` est谩 configurado en `primary` en la configuraci贸n de [agente](/docs/agents).
```json title="opencode.json"
{
"command": {
"analyze": {
"subtask": true
}
}
}
```
Esta es una opci贸n de configuraci贸n **opcional**.
---
### Modelo
Utilice la configuraci贸n `model` para anular el modelo predeterminado para este comando.
```json title="opencode.json"
{
"command": {
"analyze": {
"model": "anthropic/claude-3-5-sonnet-20241022"
}
}
}
```
Esta es una opci贸n de configuraci贸n **opcional**.
---
## Integrados
opencode incluye varios comandos integrados como `/init`, `/undo`, `/redo`, `/share`, `/help`; [m谩s informaci贸n](/docs/tui#commands).
:::note
Los comandos personalizados pueden anular los comandos integrados.
:::
Si define un comando personalizado con el mismo nombre, anular谩 el comando integrado.
|