HeyDeer CLI
Revisa tu rama y los cambios sin confirmar desde la terminal antes de abrir un pull request. La CLI de HeyDeer muestra los hallazgos donde trabajas, y los agentes de programación también pueden ejecutarla.
Instalar e iniciar sesión
La CLI necesita Node.js 22 o posterior, un repositorio en GitHub con HeyDeer instalado y acceso de escritura a ese repositorio.
npm install -g heydeer
heydeer loginheydeer login muestra un enlace y un código. Abre el enlace, inicia sesión en HeyDeer con GitHub e introduce el código. La página muestra desde dónde se pidió el inicio de sesión, así que comprueba que es tu computadora antes de permitirlo.
| Comando | Qué hace |
|---|---|
heydeer login | Inicia sesión en HeyDeer en esta computadora. |
heydeer status | Muestra en nombre de quién actúa la CLI. |
heydeer logout | Cierra la sesión en esta computadora. |
heydeer --version | Muestra la versión de la CLI que tienes instalada. |
La CLI guarda su inicio de sesión en ~/.config/heydeer/credentials.json, o en %APPDATA%\heydeer en Windows. Un inicio de sesión dura 30 días desde su último uso, y 90 días como máximo; cuando caduque, vuelve a ejecutar heydeer login.
Revisar tus cambios
Ejecuta la revisión dentro del repositorio, con una frase sobre lo que deben hacer los cambios:
heydeer review "Retry failed uploads. Fixes #123."HeyDeer revisa los commits de tu rama y los cambios sin confirmar en archivos con seguimiento, frente a la base de fusión con la rama predeterminada de origin. Lee la descripción como la de un pull request, incluidas las issues que menciona, y compara el código con ella. Para una descripción más larga, escríbela en un archivo y pasa --description-file.
La CLI muestra el repositorio, la base, la rama y la profundidad, enumera los archivos que envía y sigue el progreso de la revisión. Cuando termina, muestra cada hallazgo con su gravedad, archivo y línea.
Opciones
| Opción | Qué hace |
|---|---|
--description-file <path> | Lee la descripción de un archivo en lugar de la línea de comandos. |
--base <ref> | Compara con otra rama o commit, para trabajo dirigido a ellos. |
--include-untracked | También revisa los archivos nuevos que aún no has añadido a Git, salvo los que ignora gitignore. |
--depth standard|deep | Ejecuta esta revisión con otra profundidad distinta de la del repositorio. Profunda está en los planes de pago. |
--full | Revisa todos los cambios, no solo los posteriores a la última revisión de la rama. |
--dry-run | Enumera los archivos que se enviarían y los que se quedan en tu equipo, sin iniciar sesión ni empezar una revisión. |
--json | Muestra la revisión terminada en JSON, para scripts y agentes de programación. |
Qué se queda en tu equipo
Solo el diff desde la base de fusión y tu descripción salen de tu computadora; el resto del código HeyDeer lo lee de GitHub. La CLI deja fuera de la revisión estos archivos y los enumera en Left on this machine:
- Archivos de credenciales, como archivos .env y claves privadas.
- Cambios que contienen una credencial en un formato conocido.
- Archivos binarios.
- Un cambio en un archivo de más de 1 MB.
Todos los cambios juntos pueden sumar hasta 32 MB de diff. Si son más, pasa un --base más cercano o revisa los cambios en un pull request. Ejecuta --dry-run para ver la lista exacta antes de enviar nada.
Vuelve a ejecutarla después de corregir
Cada revisión de una rama vuelve a comprobar los hallazgos que la anterior dejó abiertos, así que la siguiente ejecución te dice cuáles resolvió tu corrección.
Si el repositorio tiene activado Revisar solo los cambios nuevos, una revisión posterior de la rama cubre solo lo que cambió desde la última revisión completa. Tras tres revisiones así, o cuando la mayoría de los cambios son posteriores a esa revisión, la siguiente vuelve a cubrir todos los cambios. Pasa --full para revisarlo todo en cualquier momento. Si nada cambió desde la última revisión, la CLI lo indica y no inicia ninguna revisión.
Usarla desde scripts y agentes de programación
Con --json, la revisión terminada va a la salida estándar como un único objeto JSON y el progreso va a la salida de error estándar. Cada hallazgo tiene una gravedad, un título, un archivo y una línea, y un texto que lo explica.
Para que Claude Code, Codex o Cursor revisen su propio trabajo antes de abrir un pull request, añade una instrucción como esta a 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.La CLI termina con uno de estos códigos:
| Código de salida | Significado |
|---|---|
| 0 | La revisión terminó, con o sin hallazgos. |
| 1 | La revisión falló, o todos los archivos cambiados tuvieron que quedarse en tu equipo. |
| 2 | El comando o sus opciones no eran válidos. |
| 130 | Cancelaste con Ctrl+C. |
Una revisión terminada sale con 0 tenga o no hallazgos, así que lee los hallazgos del JSON para decidir si una rama está lista.
Créditos
Una revisión local usa los créditos del espacio de trabajo cuya instalación cubre el repositorio, y se cobra como código privado en cualquier repositorio. Una ejecución de prueba, y una ejecución sin cambios desde la última revisión, no usan créditos. Cada persona puede iniciar hasta 30 revisiones locales por hora. Ctrl+C también cancela la revisión en HeyDeer; púlsalo dos veces para detener la CLI al instante.