Início rápido da CLI do GitHub

Sobre a GitHub CLI

A GitHub CLI é uma ferramenta de código aberto para uso do GitHub na linha de comando do computador. Quando você está trabalhando na linha de comando, você pode usar GitHub CLI para economizar tempo e evitar mudar o contexto.

Pré-requisitos

Instale a GitHub CLI no macOS, no Windows ou no Linux. Para obter instruções de instalação, confira Instalação no repositório do GitHub CLI.
Para se autenticar no GitHub, execute o comando a seguir no terminal.
```
gh auth login
```
Selecione o local em que deseja se autenticar:
- Se você acessar o GitHub no GitHub.com, selecione GitHub.com.
- Se você acessar o GitHub em um domínio diferente, selecione Outro e depois insira o nome do host (por exemplo, octocorp.ghe.com).
Siga o restante das solicitações na tela.

O GitHub CLI armazena automaticamente suas credenciais do Git quando você escolhe HTTPS como protocolo preferencial para operações Git e responde "sim" ao prompt que pergunta se deseja efetuar a autenticação no Git com suas credenciais do GitHub. Isso pode ser útil porque permite que você use comandos Git como git push e git pull sem a necessidade de configurar um gerenciador de credenciais separado ou usar SSH.

Alguns comandos úteis

Note

Ao usar alguns comandos pela primeira vez, por exemplo, gh codespace SUBCOMMAND, você será solicitado a adicionar escopos extras ao token de autenticação. Siga as instruções na tela.

Exibir o status

Insira gh status para ver detalhes do seu trabalho atual em GitHub em todos os repositórios nos quais você está inscrito.

Exibir um repositório

Insira gh repo view OWNER/REPO para ver a descrição do repositório e README.md para o repositório. Insira gh repo view OWNER/REPO --web para exibir o repositório em seu navegador padrão.

Se você executar o subcomando repo no diretório de um repositório Git local que tenha um controle remoto em GitHub, poderá omitir OWNER/REPO.

Clonando um repositório

Digite gh repo clone OWNER/REPO. Por exemplo, gh repo clone octo-org/octo-repo clona o repositório octo-org/octo-repo para o diretório do qual você executou esse comando no computador local.

Criar um repositório

Insira gh repo create e siga as instruções apresentadas na tela. Você pode criar um novo repositório vazio em GitHub e, opcionalmente, cloná-lo localmente. Como alternativa, você pode enviar um repositório local existente para GitHub e, opcionalmente, defini-lo como remoto para seu repositório local. Para obter informações sobre como definir um diretório local como um repositório Git, confira Adicionando o código localmente hospedado no GitHub.

Trabalhar com imagens

Insira gh issue list --repo OWNER/REPO para listar os problemas criados mais recentemente que estão abertos no momento para o repositório especificado. Se você executar o subcomando issue no diretório de um repositório Git local que tenha um controle remoto em GitHub, poderá omitir --repo OWNER/REPO. Por exemplo, insira gh issue list --assignee "@me" para listar problemas atribuídos a você nesse repositório ou gh issue list --author monalisa para listar problemas criados pelo usuário "monalisa".

Você também pode criar um novo problema; confira Criar um problema. Ou procure um problema; confira Filtrando e pesquisando problemas e pull requests.

Trabalhar com solicitações de pull

Insira gh pr list --repo OWNER/REPO para listar as solicitações de pull criadas mais recentemente que estão abertas no momento para o repositório especificado. Se você executar o subcomando pr no diretório de um repositório Git local que tenha um controle remoto em GitHub, poderá omitir --repo OWNER/REPO. Por exemplo, insira gh pr list --author "@me" para listar solicitações de pull abertas que você criou nesse repositório.

Insira gh pr list --label LABEL-NAME para listar solicitações de pull abertas com um rótulo específico. Insira gh search prs --review-requested=@me --state=open para listar solicitações de pull que você foi solicitado a examinar.

Para criar uma solicitação de pull, insira gh pr create e siga as instruções na tela. Para saber mais, confira Como criar uma solicitação de pull.

Trabalhar com codespaces

Para criar um novo codespace, insira gh codespace create e siga as instruções na tela.

Para exibir seus codespaces, existentes, insira gh codespace list. Para abrir um codespace na versão Web de VS Code, insira gh codespace code -w e escolha um codespace.

Em todos esses comandos, você pode substituir cs por codespace.

Obtendo ajuda

Insira gh para obter um lembrete dos comandos GitHub CLI de nível superior que você pode usar. Por exemplo, issue, pr, repo, e assim por diante.

Para cada comando e cada subcomando subsidiário, você pode acrescentar o sinalizador --help para descobrir como ele é usado. Por exemplo, gh issue --help ou gh issue create --help.

Personalizar GitHub CLI

Você pode alterar as definições de configuração e adicionar aliases ou extensões, para fazer com que GitHub CLI funcionem da maneira que melhor lhe convém.

Insira gh config set SUBCOMMANDS para definir as configurações de GitHub CLI, substituindo SUBCOMMANDS pela configuração que você deseja ajustar.

Por exemplo, você pode especificar o editor de texto que é usado quando um comando GitHub CLI requer que você edite texto, como quando você adiciona o corpo de texto para um novo problema que está criando. Para definir seu editor de texto preferencial como o Visual Studio Code, insira gh config set editor "code -w". O sinalizador -w (ou --wait) neste exemplo faz com que o comando aguarde até que o arquivo seja fechado em Visual Studio Code antes de prosseguir com a próxima etapa no terminal.

Para obter mais informações, consulte gh config set.
Defina aliases para comandos que você executa com frequência. Por exemplo, se você executar gh alias set prd "pr create --draft", poderá executar gh prd para abrir rapidamente uma solicitação de pull de rascunho. Para obter mais informações, confira gh alias.
Crie ou adicione comandos personalizados com extensões de GitHub CLI. Para saber mais, confira Usando as extensões de CLI do GitHub e Criando extensões da CLI do GitHub.

Como usar a GitHub CLI com várias contas

Se você tiver várias contas na mesma plataforma do GitHub, como o sua instância do GitHub Enterprise Server, poderá se autenticar em cada uma e alternar entre elas usando o comando gh auth switch. Confira gh auth switch no manual da GitHub CLI.

Caso você precise usar a GitHub CLI em várias plataformas do GitHub, como uma conta pessoal no GitHub.com e um conta de usuário gerenciada no GHE.com, confira Como usar a CLI do GitHub nas plataformas do GitHub.