Debuggen Ihrer GitHub Copilot-Erweiterung

Mit dem Debugtool für Copilot-Erweiterungen kannst du über die Befehlszeile mit deinem Copilot-Agent chatten, und dann detaillierte Protokolle anzeigen, nachdem dein Agent eine Antwort generiert hat. Sie können mehrere Flags an das Tool übergeben, wobei die wichtigsten Flags Folgendes sind:

• Das url-Flag, das die URL für den Zugriff auf deinen Copilot-Agent enthält. Dies ist die einzige erforderliche Kennzeichnung, um das Tool zu starten.
• Das log-level-Flag, das die Sichtbarkeitsebene bestimmt, die du für den Prozess deines Copilot-Agent zum Generieren einer Antwort hast. Die verfügbaren Protokollebenen sind DEBUG, NONE und TRACE, und das Tool wird verwendet standardmäßig DEBUG.
• Das token-Flag, das eine fine-grained personal access token mit Lesezugriff auf Copilot Chat enthalten muss, wenn dein Copilot-Agent die Copilot-LLM aufruft. Wenn Ihr Agent eine andere LLM aufruft, müssen Sie dieses Flag nicht verwenden.

Voraussetzungen

Um das Debugtool zu verwenden, müssen Sie die GitHub CLI auf Ihrem Computer installiert haben. Sie können die GitHub CLI auf eine von zwei Arten installieren:

• Über die Befehlszeile mit einem Paket-Manager. Wenn Sie beispielsweise die GitHub CLI mit Homebrew installieren möchten, fügen Sie den folgenden Befehl in die Befehlszeile ein und folgen Sie den Anweisungen:

  Bash

  brew install gh
  

• Auf der Seite GitHub CLI-Freigaben

Debuggen deiner Copilot-Erweiterung mit der CLI

1. Wenn du ein bestimmtes vom Server gesendetes Ereignis (SSE) fürs Debuggen vorbereiten möchtest, kannst du deinem Copilot-Agent Code hinzufügen, der ein SSE sendet, wenn ein Prompt ein bestimmtes Schlüsselwort enthält.

   Hinweis

   Das Debug-Tool behandelt den Nutzlastüberprüfungsprozess nicht. Um Ihre SSEs zu überprüfen, müssen Sie die Nutzlastüberprüfung für lokale Tests vorübergehend deaktivieren und diese dann erneut aktivieren, nachdem Sie die Erweiterung erfolgreich getestet haben.

2. Starte deinen Copilot-Agent über die Befehlszeile.

3. Um sich mit den GitHub CLI OAuth app zu authentifizieren, fügen Sie in einem neuen Fenster der Befehlszeilenanwendung den folgenden Befehl ein und folgen Sie den Anweisungen:

   Bash

   gh auth login --web -h github.com
   

4. Fügen Sie im selben Fenster den folgenden Befehl ein, um das Debug-Tool zu installieren:

   Bash

   gh extension install github.com/copilot-extensions/gh-debug-cli
   

5. Fügen Sie optional für eine Liste der verfügbaren Flags und deren Beschreibungen den folgenden Befehl in die Befehlszeile ein:

   Bash

   gh debug-cli -h
   

6. Legen Sie optional Umgebungsvariablen für jedes Flag fest, das Sie verwenden möchten. Umgebungsvariablen ermöglichen es Ihnen, einen Konstantenwert für ein Flag festzulegen, anstatt bei jeder Ausführung des Debug-Tools einen Wert zu übergeben. Wenn Sie beispielsweise die Blackbeard-Erweiterung zum Testen des Debug-Tools verwenden, können Sie eine Umgebungsvariable für die Agent-URL wie folgt erstellen:

   Bash

   export URL="http://localhost:3000"
   

   Hinweis

   Um eine Umgebungsvariable für ein Flag festzulegen, müssen Sie den Namen des Flags in Großbuchstaben verwenden.

7. Fügen Sie zum Starten des Debug-Tools den folgenden Befehl in die Befehlszeile ein, und fügen Sie alle zu verwendenden Flags hinzu:

   Bash

   gh debug-cli
   

   Die einzige erforderliche Kennzeichnung ist die url-Kennzeichnung, aber Sie möchten wahrscheinlich zusätzliche Flags wie log-level und token verwenden.

   Sobald das Debug-Tool ausgeführt wird, sollte die Meldung „Mit der Eingabe beginnen, um mit Ihrem Assistenten zu chatten...“ angezeigt bekommen.

8. Um mit Ihrem Agent zu interagieren, geben Sie eine Eingabeaufforderung in der Befehlszeile ein. Die Ausgabe variiert je nach der Protokollebene, die Sie im vorherigen Schritt ausgewählt haben, mit den Protokollebenen DEBUG und TRACE, die detailliertere Informationen bereitstellen.

   Tipp

   Wenn du ein SSE debuggst, sendest du einen Prompt mit dem Schlüsselwort, das du in deinem Copilot-Agent angegeben hast, um das SSE auszulösen, und analysierst dann die Ausgabe in deiner Befehlszeilenanwendung.