Исследования с GitHub Copilot CLI

/research Используйте команду косой черты для изучения сложного раздела и создания приведенного отчета из базы кода, репозиториев в GitHubи веб-источниках.

Кто может использовать эту функцию?

GitHub Copilot CLI Доступна со всеми Copilot тарифными планами. Если вы получаете Copilot от организации, Copilot CLI политика должна быть включена в настройках организации.

В этой статье

О исследованиях в Copilot CLI

Команда /research косой черты вызывает специализированный агент исследования. Он изучает тему и создает цитируемый отчет Markdown. Агент может собирать сведения из локальной базы кода, общедоступных и доступных частных репозиториев в организации и в Интернете.

Исследования оптимизированы для сложных вопросов, требующих подробного исследования. Общие сведения об исследованиях на поверхностях Copilot см. в разделе Исследование с помощью агентов.

Выполнение исследования

  1. В интерактивном Copilot CLI сеансе введите:

    Copilot prompt
    /research TOPIC

    Замените TOPIC на описание естественного языка то, что вы хотите исследовать.

  2. При появлении запроса просмотрите и подтвердите разрешения, необходимые агенту. Например, агент может запросить разрешение на создание каталога для хранения данных при компиляции исследования.

  3. Дождитесь завершения исследования. Copilot отображает сводку ключевых результатов. Он также предоставляет ссылку на полный отчет Markdown.

  4. Просмотрите отчет, включая его источники и документированные предположения.

Написание эффективного запроса на исследование

Укажите свой вопрос, область и нужный тип ответа. При необходимости включите репозитории, компоненты, технологии, ограничения или период времени для изучения.

Исследовательский агент адаптирует свой отчет к вопросу:

  • Вопросы об обработке обычно создают пошаговые инструкции.
  • Концептуальные вопросы обычно создают описания и компромиссы.
  • Технические подробные сведения могут включать схемы архитектуры и примеры кода.

Ниже приведены некоторые примеры исследовательских запросов и объяснений того, почему они работают хорошо.

Архитектура кодовой базы

Copilot prompt
/research What is the architecture of this codebase?

Почему это работает хорошо: Исследовательский агент имеет доступ к grep, globи view инструментам, соответствующим вашему текущему рабочему каталогу. Он может исследовать весь проект проекта, читать ключевые файлы и синтезировать архитектурный обзор — то, что обычный ответ чата может делать лишь поверхностно. Агент обычно создаёт архитектурные схемы, разбивки компонентов и описания потоков данных.

Как работает конкретная технология

Copilot prompt
/research How does React implement concurrent rendering?

Почему это работает хорошо: агент использует специализированные инструменты для извлечения информации из интернета и просмотра реального исходного кода React на GitHub. Ему поручено отдавать приоритет коду над документацией и предоставлять пути по файлам с номерами строк.

Понимание внутренних шаблонов реализации

Copilot prompt
/research How are feature flags implemented at our organization?

Почему это хорошо работает: агенту явно указано «всегда отдавать приоритет внутренним/частным реализациям публичным/открытым альтернативам» и сначала искать в репозиториях организации с org:ORGNAME помощью запросов. Он знает, что нужно искать внутренние паттерны именования, такие -hubкак , -service, -client.

Сравнение технологий или подходов

Copilot prompt
/research What's the difference between JWT and session-based authentication?

Почему это работает хорошо: агент адаптирует свой ответ на «концептуальные/объяснительные вопросы» с нарративными объяснениями, компромиссами и дизайнерскими решениями. Обычно используются таблицы для сравнения трёх и более элементов.

Вопросы по процессу/инструкциям

Copilot prompt
/research How do I add an endpoint to the API?

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

Глубокое погружение в конкретный компонент кодовой базы

Copilot prompt
/research How is the session management system implemented in this repo?

Почему это хорошо работает: Объединение локальных инструментов (grep, glob, view) с инструкциями агента по «отслеживанию импортов, вызовов и ссылок на типы» и «следования зависимостей» означает, что система пройдёт через саму реализацию, а не просто даст общий ответ.

Просмотр и распространение исследовательского отчёта

По завершении исследования используйте отображаемую ссылку, чтобы открыть полный отчет в редакторе Markdown по умолчанию. Кроме того, нажмите клавиши CTRL+Y , чтобы открыть последний отчет о исследованиях из текущего сеанса.

Примечание.

Редактор, используемый ctrl+Y, определяется COPILOT_EDITOR``VISUALпеременными среды или EDITOR переменными среды в этом порядке. В Linux и macOS, если ни одна из этих переменных не задана, Copilot CLI использует vi.

Чтобы создать gist, содержащий исследовательский GitHub отчет, введите:

Copilot prompt
/share gist research

Чтобы сохранить отчет в файле, введите:

Copilot prompt
/share file research [PATH]

Если опущено [PATH], отчет сохраняется в текущем рабочем каталоге с именем файла на основе темы исследования.

Используйте клавиши со стрелками и ВВОД , чтобы выбрать отчет, созданный во время текущего сеанса. Copilot CLI затем отображает URL-адрес gist или путь к сохраненного файла.

Considerations

  • Исследовательские отчеты относятся к сеансу: средство выбора отчетов и сочетание клавиш CTRL+Y отображают только отчеты из текущего сеанса. Вы по-прежнему можете получить доступ к отчетам из предыдущих сеансов ~/.copilot/session-state/SESSION-ID/research/.
  • Исследование использует выделенную модель: агент исследований использует настроенную модель независимо от модели, выбранной для основного сеанса. Вы не можете изменить модель исследования с /modelпомощью .
  • Исследование занимает больше времени, чем обычный чат: агент выполняет поиск нескольких источников и создает подробный отчет. Используйте обычный запрос для быстрых, узко ограниченных вопросов.
  • Исследования не вносят изменения в код: рабочий процесс исследования создает выводы, а не изменяет проект. Запустите или возобновите обычную задачу агента, когда вы будете готовы реализовать изменения.