heydeer
Comece

HeyDeer CLI

Revise sua branch e as alterações não commitadas pelo terminal antes de abrir um pull request. A CLI do HeyDeer mostra os problemas encontrados onde você trabalha, e agentes de programação também podem executá-la.

Instalar e entrar

A CLI precisa do Node.js 22 ou mais recente, de um repositório no GitHub com o HeyDeer instalado e de acesso de escrita a esse repositório.

npm install -g heydeer
heydeer login

heydeer login mostra um link e um código. Abra o link, entre no HeyDeer com o GitHub e digite o código. A página mostra de onde o login foi solicitado, então confira se é o seu computador antes de permitir.

ComandoO que faz
heydeer loginEntra no HeyDeer neste computador.
heydeer statusMostra em nome de quem a CLI atua.
heydeer logoutSai da conta neste computador.
heydeer --versionMostra a versão da CLI instalada.

A CLI salva o login em ~/.config/heydeer/credentials.json, ou em %APPDATA%\heydeer no Windows. Um login dura 30 dias depois do último uso, e no máximo 90 dias; quando expirar, execute heydeer login de novo.

Revisar suas alterações

Execute a revisão dentro do repositório, com uma frase sobre o que as alterações devem fazer:

heydeer review "Retry failed uploads. Fixes #123."

O HeyDeer revisa os commits da sua branch e as alterações não commitadas em arquivos rastreados, em relação à base de merge com a branch padrão de origin. Ele lê a descrição como a de um pull request, incluindo as issues mencionadas, e confere o código com ela. Para uma descrição mais longa, escreva-a em um arquivo e passe --description-file.

A CLI mostra o repositório, a base, a branch e a profundidade, lista os arquivos que envia e acompanha o progresso da revisão. Quando a revisão termina, ela mostra cada problema encontrado com a gravidade, o arquivo e a linha.

Opções

OpçãoO que faz
--description-file <path>Lê a descrição de um arquivo em vez da linha de comando.
--base <ref>Compara com outra branch ou commit, para trabalho que tenha esse destino.
--include-untrackedTambém revisa arquivos novos que você ainda não adicionou ao Git, exceto os ignorados pelo gitignore.
--depth standard|deepExecuta esta revisão com outra profundidade diferente da do repositório. Profunda está nos planos pagos.
--fullRevisa todas as alterações, não só as feitas desde a última revisão da branch.
--dry-runLista os arquivos que seriam enviados e os que ficam na sua máquina, sem entrar na conta nem iniciar uma revisão.
--jsonMostra a revisão concluída em JSON, para scripts e agentes de programação.

O que fica na sua máquina

Só o diff a partir da base de merge e a sua descrição saem do seu computador; o resto do código o HeyDeer lê do GitHub. A CLI deixa estes arquivos fora da revisão e os lista em Left on this machine:

  • Arquivos de credenciais, como arquivos .env e chaves privadas.
  • Alterações que contêm uma credencial em um formato conhecido.
  • Arquivos binários.
  • Uma alteração em um arquivo maior que 1 MB.

Todas as alterações juntas podem somar até 32 MB de diff. Se passar disso, use um --base mais próximo ou revise as alterações em um pull request. Execute --dry-run para ver a lista exata antes de enviar qualquer coisa.

Execute de novo depois de corrigir

Cada revisão de uma branch confere de novo os problemas que a anterior deixou em aberto, então a próxima execução mostra quais a sua correção resolveu.

Se o repositório estiver com Revisar apenas as alterações novas ativado, uma revisão posterior da branch cobre só o que mudou desde a última revisão completa. Depois de três revisões assim, ou quando a maioria das alterações for nova desde essa revisão, a seguinte volta a cobrir todas as alterações. Passe --full para revisar tudo a qualquer momento. Se nada mudou desde a última revisão, a CLI avisa e não inicia uma revisão.

Usar em scripts e agentes de programação

Com --json, a revisão concluída vai para a saída padrão como um único objeto JSON e o progresso vai para a saída de erro padrão. Cada problema encontrado tem gravidade, título, arquivo e linha, e um texto que o explica.

Para que o Claude Code, o Codex ou o Cursor revisem o próprio trabalho antes de abrir um pull request, adicione uma instrução como esta ao AGENTS.md:

Before opening a pull request, run `heydeer review --json "<what the change does>"`
from the repository root, fix the findings you agree with, and run it again.

A CLI termina com um destes códigos:

Código de saídaSignificado
0A revisão terminou, com ou sem problemas encontrados.
1A revisão falhou, ou todos os arquivos alterados precisaram ficar na sua máquina.
2O comando ou as opções não eram válidos.
130Você cancelou com Ctrl+C.

Uma revisão concluída sai com 0 tendo ou não problemas encontrados, então leia os problemas no JSON para decidir se uma branch está pronta.

Créditos

Uma revisão local usa os créditos do espaço de trabalho cuja instalação cobre o repositório, e é cobrada como código privado em qualquer repositório. Uma simulação, e uma execução sem alterações desde a última revisão, não usam créditos. Cada pessoa pode iniciar até 30 revisões locais por hora. Ctrl+C também cancela a revisão no HeyDeer; pressione duas vezes para parar a CLI na hora.