GitHub Copilot CLI программный справочник

Помимо интерактивного запуска Copilot CLI , вы также можете передавать запрос напрямую в CLI одной командой, не входя в интерактивную сессию. Это позволяет программно использовать Copilot скрипты, CI/CD конвейеры и автоматизацию. Дополнительные сведения см. в разделе Программный запуск GitHub Copilot CLI.

В этой статье описываются командные строки и переменные среды, которые особенно актуальны при программном запуске Copilot CLI .

Чтобы увидеть полный список доступных опций, смотрите Справочник команды GitHub Copilot CLI или введите следующую команду в вашем терминале:

copilot help

copilot help

Параметры командной строки

Существует ряд опций командной строки, которые особенно полезны при программном запуске Copilot CLI .

Выполнение динамических рабочих процессов

Используется copilot workflow run WORKFLOW-NAME для запуска динамического рабочего процесса из скрипта. Сведения о динамических рабочих процессах см. в разделе Динамические рабочие процессы.

Используется --args для встроенного JSON или пути к файлу @JSON с префиксом. Аргументы не считываются из стандартных входных данных.

copilot workflow run WORKFLOW-NAME \
  --args @workflow-input.json \
  --silent --output-format json

copilot workflow run WORKFLOW-NAME \
  --args @workflow-input.json \
  --silent --output-format json

Настройте проверку подлинности и предоставьте необходимые разрешения средства перед выполнением команды. Общие параметры, такие как --model, --allow-url``--allow-toolи --add-dir применяются. Команда не отображает запросы на утверждение разрешений. Параметры командной строки и режима сеанса, такие как -p, -i, --agent, --fleet``--autopilotи --continue``--resumeне поддерживаютсяworkflow run.

Project расширения загружаются только из доверенных папок или с явным согласием. В автоматизации GITHUB_COPILOT_PROMPT_MODE_EXTENSIONS=true разрешает загрузку расширений проекта для этого вызова. Это можно включить только для кода репозитория, которому вы доверяете. Он не предоставляет разрешения на инструмент.

Сведения обо всех параметрах, относящихся к рабочему процессу, см. в разделе Справочник команды GitHub Copilot CLI.

Выходные данные рабочего процесса

При --output-format jsonиспользовании стандартных выходных данных используется JSONL. Когда выполнение завершится или останавливается, последняя запись содержит следующие поля. Добавьте --silent для подавления хода выполнения и других записей событий.

В --result-file PATHфайле содержится только возвращаемое значение в формате JSON. Приостановленный, неудачный или прерванный запуск не заменяет существующий файл результатов. Завершенный запуск, возвращающий значение, не записывает файл результата.

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

Коды выхода рабочего процесса

Проверьте код выхода перед использованием результирующих файлов. Более ранний файл результатов по-прежнему может существовать после неудачного выполнения. Последняя запись с data.run.status набором, чтобы completed не гарантировать успешное сохранение файла результата.

Инструменты для этой --allow-tool опции

С помощью этой --allow-tool опции можно задать различные типы инструментов.

Инструментальные фильтры

Типы shellинструментов , write, urlи MCP позволяют задавать фильтр в скобках, чтобы контролировать, какие именно инструменты разрешены.

Переменные среды

Вы можете использовать переменные среды для настройки различных аспектов поведения CLI при программном запуске. Это особенно полезно для настройки конфигурации в рабочих процессах CI/CD или других автоматизированных средах, где не стоит указывать определённые опции напрямую в командной строке.

Для получения полной информации о переменных окружения Copilot CLIиспользуйте команду copilot help environment в вашем терминале.

Выбор модели

Когда вы отправляете запрос в Copilot CLI неинтерактивном режиме, модель, которую CLI использует для генерации ответа, отображается в выходе ответа (если -sопция , или --silent, не используется).

Вы можете использовать --model опцию, чтобы указать, какую модель ИИ должен использовать CLI. Это позволяет выбрать модель, которая лучше всего соответствует вашему запросу, учитывая такие факторы, как скорость, стоимость и возможности.

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

copilot -p "What does this project do?" -s --model claude-haiku-4.5

copilot -p "What does this project do?" -s --model claude-haiku-4.5

Для более сложных задач, требующих более глубокого мышления — например, отладки или рефакторинга кода — вы можете выбрать более мощную модель, например, модель GPT Codex:

copilot -p "Fix the race condition in the worker pool" \
  --model gpt-5.3-codex \
  --allow-tool='write, shell'

copilot -p "Fix the race condition in the worker pool" \
  --model gpt-5.3-codex \
  --allow-tool='write, shell'

В качестве альтернативы можно установить COPILOT_MODEL переменную среды так, чтобы она указывала модель на время сессии оболочки.

Чтобы сохранить выбор модели между сессиями оболочки, можно установить model ключ в конфигурационном файле CLI. Этот файл находится по адресу ~/.copilot/settings.json (или $COPILOT_HOME/settings.json если вы установили переменную COPILOT_HOME среды). Некоторые модели также позволяют установить уровень усилия для рассуждения, который контролирует, сколько времени модель тратит на размышления перед ответом.

{
  "model": "gpt-5.3-codex",
  "effortLevel": "low"
}

{
  "model": "gpt-5.3-codex",
  "effortLevel": "low"
}

Приоритет модели

При определении модели, которую использовать для заданного запроса, CLI проверяет спецификации модели в следующем порядке приоритета (от самого высокого к наименьшему):

• Где используется пользовательский агент: модель, указанная в определении пользовательского агента (если таковая есть).
• Опция командной --model строки.
• Переменная среды COPILOT_MODEL.
• Ключ model в конфигурационном файле (~/.copilot/settings.json или $COPILOT_HOME/settings.json).
• Стандартная модель CLI.

Использование кастомных агентов

Вы можете делегировать работу специализированному агенту, используя эту --agent опцию. Дополнительные сведения см. в разделе Создание и использование пользовательских агентов для GitHub Copilot CLI.

В этом примере code-review используется агент. Для этого требуется, чтобы с этим именем был создан пользовательский агент.

copilot -p "Review the latest commit" \
  --allow-tool='shell' \
  --agent code-review

Дополнительные материалы

• GitHub Copilot CLI
• Справочник команды GitHub Copilot CLI
• Ссылка на плагин GitHub Copilot CLI