Início rápido da CLI GitHub

Sobre o 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

Observação

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

Exibir o status

Digite gh status para ver os detalhes do seu trabalho atual em GitHub em todos os repositórios aos 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 remoto em GitHub, poderá omitir OWNER/REPO.

Clonar 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 fazer push de um repositório local existente para GitHub e, opcionalmente, defini-lo como remoto do seu repositório local. Para obter informações sobre como definir um diretório local como um repositório Git, consulte 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 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, ver Criar um problema ou pesquisar um problema, consulte 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 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 do VS Code, digite gh codespace code -w e escolha um codespace.

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

Obtendo ajuda

Digite gh para ver 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 configurações e adicionar aliases ou extensões para fazer GitHub CLI o trabalho da maneira mais adequada para você.

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

Por exemplo, você pode especificar o editor de texto usado quando um GitHub CLI comando exige que você edite o texto , como quando você adiciona o texto do corpo para um novo problema que está criando. Para definir Visual Studio Code como seu editor de texto preferido, digite gh config set editor "code -w". A opção -w (ou --wait) neste exemplo faz com que o comando aguarde até que o arquivo seja fechado em Visual Studio Code antes de prosseguir para 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, consulte gh alias.
Crie ou adicione comandos personalizados com GitHub CLI extensões. Para obter mais informações, consulte Usando extensões da CLI GitHub e Criando extensões da CLI GitHub.

Usando GitHub CLI com várias contas

Se você tiver várias contas na mesma GitHub plataforma, por GitHub.comexemplo, poderá se autenticar em cada uma delas e alternar entre elas usando o gh auth switch comando. Consulte a opção gh auth no GitHub CLI manual.

Se você precisar usar o GitHub CLI em várias GitHub plataformas, como uma conta pessoal no GitHub.com e um conta de usuário gerenciada no GHE.com, consulte Usando a CLI de GitHub nas plataformas do GitHub.

Neste artigo