GitHub CLI pocket manual
A GitHub CLI é uma ferramenta de código aberto para uso do GitHub na linha de comando do computador, uma alternativa ao comando git
. Quando você está trabalhando na linha de comando, você pode usar GitHub CLI para economizar tempo e evitar mudar o contexto.
Se é seu caso de está começando do zero, recomendo seguir os seguintes passos: 1. Instalar o programa, 2. logar e ditigar alguns comandos para ir familiarizando, por exemplo: digite gh
para listar os comandos, gh comando
para listar os subcomandos, gh comando subcomando
para ter uma resposta completa.
gh autenticação
Para se autenticar no GitHub, execute o comando a seguir no terminal.
gh auth login
Segundo o Gitbhub, é necessário que 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).
O GitHub CLI armazena automaticamente suas credenciais do Git, 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.
gh Exibir o status
gh status
para ver detalhes do seu trabalho atual em GitHub em todos os repositórios nos quais você está inscrito.
gh Exibir um repositório
para ver a descrição do repositório:
gh repo view OWNER/REPO
gh repo view OWNER/REPO --web
gh Clonando um repositório
Digite o comando seguinte, por exemplo, gh repo clone octo-org/octo-repo clona o repositório
gh repo clone OWNER/REPO
gh Criar um repositório
gh repo create
gh repo create REPO --public -ou- --private
siga as instruções apresentadas na tela. Você pode criar um novo repositório vazio em GitHub e, opcionalmente, cloná-lo localmente.
gh solicitações de pull
Para listar as solicitações de pull criadas mais recentemente que estão abertas no momento para o repositório especificado.
gh pr list --repo OWNER/REPO
gh pr list --author "@me"
gh pr list --label LABEL-NAME
gh search prs --review-requested=@me --state=open
gh pr list
gh issue list
ghcom várias contas
Várias contas na mesma plataforma do GitHub, como o GitHub.com, poderá se autenticar em cada uma e alternar entre elas usando o comando seguinte:
gh auth switch
Workflow
Agilizar o action workflow
gh workflow run ID ou NOME
Listar os workflows no repositório
gh workflow list
O histórico do workflow pages-build-deployment
no Actions
gh run list --workflow=pages-build-deployment
Ver um action da lista mostrada no comando anterior:
gh run view 12850000632
Pull Requests
gh pr create
parâmetros do comando:
Com o parâmetro -B podemos especificar o base branch, isto é, para qual branch essas alterações serão enviadas após o merge:
gh pr create -B main
Com o parâmetro -d podemos especificar que se trata de um Draft Pull Request:
gh pr create -d
Fechar/reabrir um Pull Request:
gh pr close/reopen
Mergear um Pull Request:
gh pr merge
Listar Pull Requests:
gh pr list
Ver o diff de um Pull Request:
gh pr diff
Revisar um Pull Request:
gh pr review
Verificar os status checks de um Pull Request aberto:
gh pr checks
Verificar seu status de Pull Requests:
gh pr status
Issues
Para criar uma Issue:
gh issue create
Fechar/reabrir uma Issue:
gh issue close/reopen
Listar Issues:
gh issue list
Ver uma Issue:
gh issue view
Verificar seu status de Issues:
gh issue status