Gerenciar sua extensão do GitHub Copilot

Com a ferramenta de depuração para Extensões do Copilot, você pode conversar com seu Agente do Copilot na linha de comando e, em seguida, visualizar logs detalhados à medida que seu agente gera uma resposta. Você pode passar vários sinalizadores para a ferramenta, sendo os sinalizadores mais importantes:

• O sinalizador url, que contém a URL para acessar seu Agente do Copilot. Este é o único sinalizador necessário para iniciar a ferramenta.
• O sinalizador log-level, que determina o nível de visibilidade que você tem no processo de geração de resposta do seu Agente do Copilot. Os níveis de log disponíveis são DEBUG, NONE e TRACE, e a ferramenta usa DEBUG por padrão.
• O sinalizador token, que precisa conter um fine-grained personal access token com acesso de leitura a Copilot Chat se o seu Agente do Copilot chamar o LLM do Copilot. Se o agente chamar um LLM diferente, você não precisará usar esse sinalizador.

Pré-requisitos

Para usar a ferramenta de depuração, você precisa ter o GitHub CLI instalado em sua máquina. Você pode instalar o GitHub CLI de duas maneiras:

• Na linha de comando usando um gerenciador de pacotes. Por exemplo, para instalar o GitHub CLI com o Homebrew, cole o seguinte comando na linha de comando e siga as instruções:

  Bash

  brew install gh
  

• Na página de versões do GitHub CLI

Depurar seu Extensão do Copilot com o CLI

1. Opcionalmente, para se preparar para depurar um evento enviado pelo servidor (SSE) específico, adicione algum código ao seu Agente do Copilot que envia um SSE quando um prompt contém uma determinada palavra-chave.

   Observação

   A ferramenta de depuração não lida com o processo de verificação de payload. Para validar seus SSEs, você precisa desabilitar temporariamente a verificação de payload para testes locais e reativá-la depois de testar sua extensão com êxito.

2. Na linha de comando, inicie o seu Agente do Copilot.

3. Para autenticar com o GitHub CLI OAuth app, em uma nova janela do aplicativo de linha de comando, cole o seguinte comando e siga os prompts:

   Bash

   gh auth login --web -h github.com
   

4. Na mesma janela, para instalar a ferramenta de depuração, cole o seguinte comando:

   Bash

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

5. Opcionalmente, para obter uma lista de sinalizadores disponíveis e suas descrições, cole o seguinte comando na linha de comando:

   Bash

   gh debug-cli -h
   

6. Opcionalmente, defina variáveis de ambiente para cada sinalizador que você deseja usar. As variáveis de ambiente permitem que você defina um valor constante para um sinalizador em vez de passar um valor sempre que executar a ferramenta de depuração. Por exemplo, se você estiver usando a extensão Blackbeard para testar a ferramenta de depuração, poderá criar uma variável de ambiente para a URL do agente da seguinte maneira:

   Bash

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

   Observação

   Para definir uma variável de ambiente para um sinalizador, você deve usar o nome do sinalizador em maiúsculas.

7. Para iniciar a ferramenta de depuração, cole o seguinte comando na linha de comando, adicionando os sinalizadores que deseja usar:

   Bash

   gh debug-cli
   

   O único sinalizador necessário é o sinalizador url, mas você provavelmente desejará usar sinalizadores adicionais como log-level e token.

   Depois que a ferramenta de depuração estiver em execução, você verá uma mensagem que diz "Comece a digitar para conversar com seu assistente...".

8. Para interagir com seu agente, insira um prompt na linha de comando. A saída varia de acordo com o nível de log escolhido na etapa anterior, com os níveis de log DEBUG e TRACE fornecendo informações mais detalhadas.

   Dica

   Se você estiver depurando um SSE, envie um prompt contendo a palavra-chave especificada em seu Agente do Copilot para acionar o SSE e, em seguida, analise a saída em seu aplicativo de linha de comando.