Skip to main content

Использование расширений GitHub CLI

Узнайте, как использовать пользовательские расширения, написанные другими пользователями GitHub CLI.

Сведения о расширениях GitHub CLI

Note

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

Расширения GitHub CLI — это пользовательские команды GitHub CLI, которые может создавать и применять любой пользователь. Дополнительные сведения о создании расширений GitHub CLI см. в разделе "Создание расширений GitHub CLI".

Расширения устанавливаются локально и ограничены пользователем. Таким образом, если вы обращаетесь к GitHub CLI с другого компьютера или другой пользователь обращается к GitHub CLI с того же компьютера, расширение будет недоступно.

Поиск расширений

Расширения можно найти, просмотрев репозитории с темой gh-extension.

Установка расширений

Чтобы установить расширение, используйте подкоманду extensions install. Замените параметр repo на репозиторий расширения. Можно использовать полный URL-адрес, например https://github.com/octocat/gh-whoami, или только владельца и репозитория, например octocat/gh-whoami.

Если используется владелец и репозиторий, ghустановит расширение с использованием имени узла, к которому gh в настоящее время выполняет проверку подлинности. Формат полного URL-адреса полезен при установке расширений с другого узла. Например, пользователи на GitHub Enterprise Server должны использовать полный URL-адрес репозитория, чтобы установить расширения с GitHub.com или любого другого узла.

Чтобы установить расширение в разработке из текущего каталога, используйте . в качестве значения для параметра repo.

gh extension install REPO

Если у вас уже установлено расширение с тем же именем, команда завершится ошибкой. Например, если вы уже установили octocat/gh-whoami, то необходимо его удалить перед установкой hubot/gh-whoami.

Запуск расширения

При установке расширения вы запускаете расширение, выполнив собственную команду GitHub CLI с помощью gh EXTENSION-NAMEкоманды . Имя EXTENSION-NAME репозитория, содержащего расширение, минус gh- префикс.

Например, если вы установили расширение из octocat/gh-whoami репозитория, выполните расширение с помощью следующей команды.

gh whoami

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

Отображение установленных расширений

Чтобы просмотреть все установленные расширения, используйте подкоманду extensions list. В выходных данных также будет указано, для каких расширений доступны обновления.

gh extension list

Обновление расширений

Чтобы обновить расширение, используйте подкоманду extensions upgrade. Замените параметр extension на имя расширения.

gh extension upgrade EXTENSION

Чтобы обновить все установленные расширения, используйте флаг --all.

gh extension upgrade --all

Удаление расширений

Чтобы удалить расширение, используйте подкоманду extensions remove. Замените параметр extension на имя расширения.

gh extension remove EXTENSION