Comandos

Crea comandos personalizados para tareas repetitivas.

Los comandos personalizados te permiten especificar un prompt que quieres ejecutar cuando ese comando se ejecuta en la TUI.

/my-command

Los comandos personalizados se suman a los comandos integrados como /init, /undo, /redo, /share, /help. Más información.

Crear archivos de comandos

Crea archivos markdown en el directorio commands/ para definir comandos personalizados.

Crea .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.

Usa el comando escribiendo / seguido del nombre del comando.

"/test"

Configurar

Puedes agregar comandos personalizados a través de la configuración de OpenCode o creando archivos markdown en el directorio commands/.

JSON

Usa la opción command en tu configuración de OpenCode:

{
  "$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 la TUI:

/test

Markdown

También puedes definir comandos usando archivos markdown. Colócalos en:

• Global: ~/.config/opencode/commands/
• Por proyecto: .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.

El nombre del archivo markdown se convierte en el nombre del comando. Por ejemplo, test.md te permite ejecutar:

/test

Configuración del prompt

Los prompts de los comandos personalizados admiten varios marcadores de posición y sintaxis especiales.

Argumentos

Pasa argumentos a los comandos usando el marcador $ARGUMENTS.

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

Ejecuta el comando con argumentos:

/component Button

Y $ARGUMENTS se reemplazará por Button.

También puedes acceder a argumentos individuales usando parámetros posicionales:

• $1 - Primer argumento
• $2 - Segundo argumento
• $3 - Tercer argumento
• Y así sucesivamente...

Por ejemplo:

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

Ejecuta el comando:

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

Esto reemplaza:

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

Salida de shell

Usa !command para inyectar la salida de comandos bash en tu prompt.

Por ejemplo, para crear un comando personalizado que analice la cobertura de pruebas:

---
description: Analyze test coverage
---
 
Here are the current test results:
!`npm test`
 
Based on these results, suggest improvements to increase coverage.

O para revisar los cambios recientes:

---
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 tu proyecto y su salida se convierte en parte del prompt.

Referencias a archivos

Incluye archivos en tu comando usando @ seguido del nombre del archivo.

---
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 prompt.

Opciones

Veamos las opciones de configuración en detalle.

Template

La opción template define el prompt que se enviará al LLM cuando se ejecute el comando.

{
  "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.

Description

Usa la opción description para proporcionar una breve descripción de lo que hace el comando.

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

Esto se muestra como la descripción en la TUI cuando escribes el comando.

Agent

Usa la configuración agent para especificar opcionalmente qué agente debe ejecutar este comando. Si es un subagente, el comando activará una invocación de subagente por defecto. Para deshabilitar este comportamiento, establece subtask en false.

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

Esta es una opción de configuración opcional. Si no se especifica, usa por defecto tu agente actual.

Subtask

Usa el booleano subtask para forzar que el comando active una invocación de subagente. Esto es útil si quieres que el comando no contamine tu contexto principal y forzará al agente a actuar como subagente, incluso si mode está establecido en primary en la configuración del agente.

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

Esta es una opción de configuración opcional.

Model

Usa la configuración model para anular el modelo por defecto para este comando.

{
  "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.

Nota: Los comandos personalizados pueden anular los comandos integrados.

Si defines un comando personalizado con el mismo nombre, anulará el comando integrado.