Sobre extensões de GitHub CLI
Observação: As extensões fora de GitHub Enterprise Server e GitHub CLI não são certificadas por GitHub Enterprise Server e são regidas por termos de serviço separados, política de privacidade e documentação de suporte. Para mitigar o risco ao usar extensões de terceiros, faça a auditoria do código-fonte da extensão antes de instalá-la ou atualizá-la.
As extensões de GitHub CLI são comandos de GitHub CLI personalizados que qualquer um pode criar e usar. Para obter mais informações sobre como criar extensões de GitHub CLI, consulte "Criando extensões de GitHub CLI".
As extensões são instaladas localmente e têm seu escopo definido para o usuário. Portanto, se você acessar GitHub CLI de uma máquina diferente ou outro usuário acessar GitHub CLI da mesma máquina, a extensão não estará disponível.
Localizando extensões
Você pode encontrar extensões acessando repositórios com o tópico de gh-extension
.
Instalando as extensões
Para instalar uma extensão, use o subcomando extensions install
. Substitua o parâmetro repo
pelo repositório da extensão. Você pode usar a URL completa, como https://github.com/octocat/gh-whoami
ou apenas o proprietário e o repositório, como octocat/gh-whoami
.
Se o proprietário e repositório forem usados, gh
irá instalar a extensão usando o nome de host com o qual gh
está atualmente autenticado. O formato completo da URL é útil ao instalar extensões de um host diferente. Por exemplo, os usuários em GitHub Enterprise Server devem usar a URL completa do repositório para instalar extensões de GitHub.com ou de qualquer outro host.
Para instalar uma extensão em desenvolvimento a partir do diretório atual, use .
como o valor para o parâmetro repo
.
gh extension install repo
Se você já tem uma extensão com o mesmo nome instalado, o comando irá falhar. Por exemplo, se você instalou octocat/gh-whoami
, você deverá desinstalá-lo antes de instalar hubot/gh-whoami
.
Visualizando extensões instaladas
Para ver todas as extensões instaladas, use o subcomando lista de extensões
. A saída também informará quais extensões possuem atualizações disponíveis.
gh extension list
Atualizando extensões
Para atualizar uma extensão, use o subcomando extensions upgrade
. Substitua o parâmetro extensão
pelo nome da extensão.
gh extension upgrade extension
Para atualizar todas as extensões instaladas, use o sinalizador --all
.
gh extension upgrade --all
Desinstalando extensões
Para desinstalar uma extensão, use o subcomando extensions remove
. Substitua o parâmetro extensão
pelo nome da extensão.
gh extension remove extension