Depuración de GitHub Copilot Extension

Con la herramienta de depuración para Copilot Extensions, puede chatear con Copilot agent desde la línea de comandos y, a continuación, ver los registros detallados a medida que el agente genera una respuesta. Puede pasar varias marcas a la herramienta, siendo las marcas más importantes:

• Marca url, que contiene la dirección URL para acceder a Copilot agent. Esta es la única marca necesaria para iniciar la herramienta.
• La marca log-level, que determina el nivel de visibilidad que tiene en el proceso Copilot agent para generar una respuesta. Los niveles de registro disponibles son DEBUG, NONE y TRACE, y la herramienta usa DEBUG de forma predeterminada.
• La marca token, que debe contener un fine-grained personal access token con acceso de lectura a Copilot Chat si Copilot agent llaman a los LLM Copilot. Si el agente llama a un LLM diferente, no es necesario usar esta marca.

Requisitos previos

Para usar la herramienta de depuración, debe tener instalados los GitHub CLI en el equipo. Puede instalar GitHub CLI de una de estas dos maneras:

• Desde la línea de comandos mediante un administrador de paquetes. Por ejemplo, para instalar GitHub CLI con Homebrew, pegue el siguiente comando en la línea de comandos y siga las indicaciones:

  Bash

  brew install gh
  

• En la página de versiones de GitHub CLI

Depurar Copilot Extension con la CLI.

1. Opcionalmente, para preparar la depuración de un evento enviado por el servidor (SSE) específico, agregue código a Copilot agent que envía un SSE cuando un símbolo del sistema contiene una palabra clave determinada.

   Note

   La herramienta de depuración no controla el proceso de comprobación de carga. Para validar los SSE, debe deshabilitar temporalmente la comprobación de carga para las pruebas locales y volver a habilitarla después de haber probado correctamente la extensión.

2. Inicie Copilot agent en la línea de comandos.

3. Para autenticarse con GitHub CLI OAuth app, en una nueva ventana de la aplicación de línea de comandos, pegue el siguiente comando y siga las indicaciones:

   Bash

   gh auth login --web -h github.com
   

4. En la misma ventana, para instalar la herramienta de depuración, pegue el siguiente comando:

   Bash

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

5. Opcionalmente, para obtener una lista de marcas disponibles y sus descripciones, pegue el siguiente comando en la línea de comandos:

   Bash

   gh debug-cli -h
   

6. Opcionalmente, establezca variables de entorno para cada marca que quiera usar. Las variables de entorno permiten establecer un valor constante para una marca en lugar de pasar un valor en cada vez que se ejecuta la herramienta de depuración. Por ejemplo, si usa la extensión Blackbeard para probar la herramienta de depuración, puede crear una variable de entorno para la dirección URL del agente de la siguiente manera:

   Bash

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

   Note

   Para establecer una variable de entorno para una marca, debe usar el nombre de la marca en todos los límites.

7. Para iniciar la herramienta de depuración, pegue el siguiente comando en la línea de comandos y agregue las marcas que quiera usar:

   Bash

   gh debug-cli
   

   La única marca necesaria es la marca url, pero es probable que quiera usar marcas adicionales como log-level y token.

   Una vez que se esté ejecutando la herramienta de depuración, debería ver un mensaje en el que se lea "Empiece a escribir para chatear con el asistente...".

8. Para interactuar con el agente, escriba un símbolo del sistema en la línea de comandos. La salida variará en función del nivel de registro que eligió en el paso anterior; los niveles de registro DEBUG y TRACE proporcionan información más detallada.

   Tip

   Si está depurando un SSE, envíe un mensaje que contenga la palabra clave que especificó en Copilot agent para desencadenar el SSE y, a continuación, analice la salida en la aplicación de línea de comandos.