Отладка расширения GitHub Copilot

С помощью средства отладки для Copilot Extensionsвы можете общаться с Copilot agent из командной строки, а затем просматривать подробные журналы, как агент создает ответ. Вы можете передать несколько флагов в инструмент с наиболее важными флагами:

• Флаг url , содержащий URL-адрес для доступа к данным Copilot agent. Это единственный обязательный флаг для запуска средства.
• Флаг log-level , определяющий уровень видимости, который вы получили в процессе Copilot agentдля создания ответа. Доступные уровни журналов: DEBUGи , а TRACEсредство используется DEBUG NONEпо умолчанию.
• Флаг token , который должен содержать fine-grained personal access token с доступом на чтение к Copilot Chat, если Copilot agent вызывает Copilot LLM. Если агент вызывает другой LLM, вам не нужно использовать этот флаг.

Необходимые компоненты

Чтобы использовать средство отладки, необходимо установить на компьютере GitHub CLI . Можно установить GitHub CLI одним из двух способов:

• Из командной строки с помощью диспетчера пакетов. Например, чтобы установить GitHub CLI с Помощью Homebrew, вставьте следующую команду в командную строку, а затем выполните следующие запросы:

  Bash

  brew install gh
  

• На странице выпусков GitHub CLI

Отладка данных Copilot Extension с помощью ИНТЕРФЕЙСА командной строки

1. При необходимости для подготовки к отладке определенного события, отправленного сервером (SSE), добавьте код в Copilot agent, который отправляет SSE при появлении запроса определенного ключевого слова.

   Note

   Средство отладки не обрабатывает процесс проверки полезных данных. Чтобы проверить SSES, необходимо временно отключить проверку полезных данных для локального тестирования, а затем повторно включить ее после успешного тестирования расширения.

2. В командной строке запустите Copilot agent.

3. Чтобы выполнить проверку подлинности с помощью GitHub CLI OAuth app, в новом окне приложения командной строки вставьте следующую команду и следуйте инструкциям:

   Bash

   gh auth login --web -h github.com
   

4. В том же окне, чтобы установить средство отладки, вставьте следующую команду:

   Bash

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

5. При необходимости для списка доступных флагов и их описаний вставьте следующую команду в командную строку:

   Bash

   gh debug-cli -h
   

6. При необходимости задайте переменные среды для каждого флага, который вы хотите использовать. Переменные среды позволяют задать константное значение для флага, а не передавать значение при каждом запуске средства отладки. Например, если для тестирования средства отладки используется расширение Blackbeard, можно создать переменную среды для URL-адреса агента следующим образом:

   Bash

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

   Note

   Чтобы задать переменную среды для флага, необходимо использовать имя флага во всех крышках.

7. Чтобы запустить средство отладки, вставьте следующую команду в командную строку, добавив все флаги, которые вы хотите использовать:

   Bash

   gh debug-cli
   

   Единственным обязательным флагом url является флаг, но вы, скорее всего, хотите использовать дополнительные флаги, например log-level и token.

   После запуска средства отладки появится сообщение, которое считывает сообщение "Начать ввод в чат с помощником...".

8. Чтобы взаимодействовать с агентом, введите строку в командной строке. Выходные данные зависят от уровня журнала, выбранного на предыдущем шаге, а DEBUG TRACE уровни журналов предоставляют более подробную информацию.

   Tip

   Если выполняется отладка SSE, отправьте запрос, содержащий ключевое слово, указанное в Copilot agent для активации SSE, а затем проанализируйте выходные данные в приложении командной строки.