Befehle

Erstellen Sie benutzerdefinierte Befehle für sich wiederholende Aufgaben.

Mit benutzerdefinierten Befehlen können Sie eine Eingabeaufforderung angeben, die ausgeführt werden soll, wenn dieser Befehl im TUI ausgeführt wird.

/my-command

Benutzerdefinierte Befehle gibt es zusätzlich zu den integrierten Befehlen wie /init, /undo, /redo, /share, /help. Learn more.

Befehlsdateien erstellen

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

Erstellen Sie .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 Frontmatter definiert Befehlseigenschaften. Der Inhalt wird zur Vorlage.

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

"/test"

Konfigurieren

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

JSON

Verwenden Sie die Option command in Ihrem OpenCode config:

{
  "$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 im TUI ausführen:

/test

Markdown

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

Global: ~/.config/opencode/commands/
Pro Projekt: .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.

Der Name der Markdown-Datei wird zum Befehlsnamen. Zum Beispiel test.md lässt Du läufst:

/test

Prompt-Konfiguration

Die Eingabeaufforderungen für die benutzerdefinierten Befehle unterstützen mehrere spezielle Platzhalter und Syntax.

Arguments

Übergeben Sie Argumente an Befehle mithilfe des Platzhalters $ARGUMENTS.

---
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 über Positionsparameter auf einzelne Argumente zugreifen:

$1 – Erstes Argument
$2 – Zweites Argument
$3 – Drittes Argument
Und so weiter…

Zum Beispiel:

---
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 mit config.json
$2 mit src
$3 mit { "key": "value" }

Shell-Ausgabe

Verwenden Sie !command, um die Ausgabe bash command in Ihre Eingabeaufforderung einzufügen.

So erstellen Sie beispielsweise einen benutzerdefinierten Befehl, der die Testabdeckung analysiert:

---
description: Analyze test coverage
---

Here are the current test results:
!`npm test`

Based on these results, suggest improvements to increase coverage.

Oder um die letzten Änderungen zu überprüfen:

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

Dateiverweise

Fügen Sie Dateien in Ihren Befehl ein, indem Sie @ folgend vom Dateinamen verwenden.

---
description: Review component
---

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

Der Dateiinhalt wird automatisch in die Eingabeaufforderung einbezogen.

Options

Schauen wir uns die Konfigurationsmöglichkeiten im Detail an.

Template

Die Option template die Eingabeaufforderung, die an LLM gesendet wird, wenn der Befehl ausgeführt wird.

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

Beschreibung

Verwenden Sie die Option description, um eine kurze Beschreibung der Funktion des Befehls bereitzustellen.

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

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

Verwenden Sie die agent-Konfiguration, um optional anzugeben, welche agent diesen Befehl ausführen soll. Wenn es sich um einen subagent handelt, löst der Befehl standardmäßig einen Subagentenaufruf aus. Um dieses Verhalten zu deaktivieren, setzen Sie subtask auf false.

{
  "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 zu erzwingen, dass der Befehl einen subagent-Aufruf auslöst. Dies ist nützlich, wenn Sie möchten, dass der Befehl Ihren primären Kontext nicht verunreinigt und den Agenten dazu zwingt, als Subagent zu fungieren. auch wenn mode in der agent-Konfiguration auf primary gesetzt ist.

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

Dies ist eine optionale Konfigurationsoption.

Modell

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

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

Dies ist eine optionale Konfigurationsoption.

Eingebaut

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

Wenn Sie einen benutzerdefinierten Befehl mit demselben Namen definieren, überschreibt dieser den integrierten Befehl.