Befehle

Erstellen Sie benutzerdefinierte Befehle für wiederkehrende Aufgaben.

Mit benutzerdefinierten Befehlen können Sie einen Prompt angeben, der ausgeführt werden soll, wenn dieser Befehl in der TUI ausgeführt wird.

/my-command

Benutzerdefinierte Befehle ergänzen die integrierten Befehle wie /init, /undo, /redo, /share, /help. Mehr erfahren.

Befehlsdateien erstellen

Erstellen Sie Markdown-Dateien im Verzeichnis commands/, um benutzerdefinierte Befehle zu definieren.

Erstellen Sie .opencode/commands/test.md:

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

Das Frontmatter definiert die Befehlseigenschaften. Der Inhalt wird zur Vorlage.

Verwenden Sie den Befehl, indem Sie / gefolgt vom Befehlsnamen eingeben.

/test

Konfigurieren

Sie können benutzerdefinierte Befehle über die OpenCode-Konfiguration oder durch Erstellen von Markdown-Dateien im Verzeichnis commands/ hinzufügen.

JSON

Verwenden Sie die Option command in Ihrer OpenCode-Konfiguration:

opencode.jsonc

{
  "$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"
    }
  }
}

Jetzt können Sie diesen Befehl in der TUI ausführen:

/test

Markdown

Sie können Befehle auch mit Markdown-Dateien definieren. Platzieren Sie sie in:

Global: ~/.config/opencode/commands/
Pro Projekt: .opencode/commands/

~/.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.

Der Markdown-Dateiname wird zum Befehlsnamen. Zum Beispiel ermöglicht test.md die Ausführung von:

/test

Prompt-Konfiguration

Die Prompts für benutzerdefinierte Befehle unterstützen mehrere spezielle Platzhalter und Syntax.

Argumente

Übergeben Sie Argumente an Befehle mit dem Platzhalter $ARGUMENTS.

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

Führen Sie den Befehl mit Argumenten aus:

/component Button

Und $ARGUMENTS wird durch Button ersetzt.

Sie können auch auf einzelne Argumente mit Positionsparametern zugreifen:

$1 - Erstes Argument
$2 - Zweites Argument
$3 - Drittes Argument
Und so weiter...

Zum Beispiel:

.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

Führen Sie den Befehl aus:

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

Dies ersetzt:

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

Shell-Ausgabe

Verwenden Sie !command, um Bash-Befehl-Ausgaben in Ihren Prompt zu injizieren.

Zum Beispiel, um einen benutzerdefinierten Befehl zu erstellen, der die Testabdeckung analysiert:

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

Oder um kürzliche Änderungen zu überprüfen:

.opencode/commands/review-changes.md

---
description: Review recent changes
---
 
Recent git commits:
!`git log --oneline -10`
 
Review these changes and suggest any improvements.

Befehle werden im Stammverzeichnis Ihres Projekts ausgeführt und ihre Ausgabe wird Teil des Prompts.

Dateireferenzen

Binden Sie Dateien in Ihren Befehl ein, indem Sie @ gefolgt vom Dateinamen verwenden.

.opencode/commands/review-component.md

---
description: Review component
---
 
Review the component in @src/components/Button.tsx.
Check for performance issues and suggest improvements.

Der Dateiinhalt wird automatisch in den Prompt eingefügt.

Optionen

Schauen wir uns die Konfigurationsoptionen im Detail an.

Template

Die Option template definiert den Prompt, der an das LLM gesendet wird, wenn der Befehl ausgeführt wird.

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

Dies ist eine erforderliche Konfigurationsoption.

Description

Verwenden Sie die Option description, um eine kurze Beschreibung dessen zu geben, was der Befehl tut.

opencode.json

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

Dies wird als Beschreibung in der TUI angezeigt, wenn Sie den Befehl eingeben.

Agent

Verwenden Sie die Konfiguration agent, um optional anzugeben, welcher Agent diesen Befehl ausführen soll. Wenn dies ein Subagent ist, löst der Befehl standardmäßig einen Subagent-Aufruf aus. Um dieses Verhalten zu deaktivieren, setzen Sie subtask auf false.

opencode.json

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

Dies ist eine optionale Konfigurationsoption. Wenn nicht angegeben, wird standardmäßig Ihr aktueller Agent verwendet.

Subtask

Verwenden Sie den booleschen Wert subtask, um den Befehl zu zwingen, einen Subagent-Aufruf auszulösen. Dies ist nützlich, wenn Sie möchten, dass der Befehl Ihren primären Kontext nicht verschmutzt, und zwingt den Agent, als Subagent zu agieren, selbst wenn mode in der Agent-Konfiguration auf primary gesetzt ist.

opencode.json

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

Dies ist eine optionale Konfigurationsoption.

Model

Verwenden Sie die Konfiguration model, um das Standardmodell für diesen Befehl zu überschreiben.

opencode.json

{
  "command": {
    "analyze": {
      "model": "anthropic/claude-3-5-sonnet-20241022"
    }
  }
}

Dies ist eine optionale Konfigurationsoption.

Integrierte Befehle

OpenCode enthält mehrere integrierte Befehle wie /init, /undo, /redo, /share, /help; mehr erfahren.

Hinweis

Benutzerdefinierte Befehle können integrierte Befehle überschreiben.

Wenn Sie einen benutzerdefinierten Befehl mit demselben Namen definieren, wird der integrierte Befehl überschrieben.

Tastenkürzel Formatierer