Skip to main content

Usando as extensões de CLI do GitHub

Aprenda a usar extensões personalizadas escritas por outros usuários de GitHub CLI.

Sobre extensões de GitHub CLI

Observação: as extensões fora do GitHub Enterprise Server e da GitHub CLI não são certificadas pelo GitHub Enterprise Server e são regidas por termos de serviço, política de privacidade e documentação de suporte separados. 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 da GitHub CLI, confira "Como criar extensões da 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.

Encontrar extensões

Encontre extensões navegando por repositórios com o tópico gh-extension.

Instalar extensões

Para instalar uma extensão, use o subcomando extensions install. Substitua o parâmetro repo pelo repositório da extensão. Use 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 o repositório forem usados, o gh instalará a extensão usando o nome do host no qual o gh está autenticado no momento. 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 do diretório atual, use . como o valor do 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ê tiver o octocat/gh-whoami instalado, precisará desinstalá-lo antes de instalar o hubot/gh-whoami.

Visualizando extensões instaladas

Para ver todas as extensões instaladas, use o subcomando extensions list. A saída também informará quais extensões possuem atualizações disponíveis.

gh extension list

Atualizar extensões

Para atualizar uma extensão, use o subcomando extensions upgrade. Substitua o parâmetro extension pelo nome da extensão.

gh extension upgrade extension

Para atualizar todas as extensões instaladas, use o sinalizador --all.

gh extension upgrade --all

Desinstalar extensões

Para desinstalar uma extensão, use o subcomando extensions remove. Substitua o parâmetro extension pelo nome da extensão.

gh extension remove extension