HeyDeer CLI
풀 리퀘스트를 열기 전에 터미널에서 브랜치와 커밋하지 않은 변경 사항을 검토하세요. HeyDeer CLI는 작업하는 곳에 발견 사항을 출력하며, 코딩 에이전트도 실행할 수 있습니다.
설치 및 로그인
CLI를 사용하려면 Node.js 22 이상, HeyDeer가 설치된 GitHub 저장소, 그리고 해당 저장소에 대한 쓰기 권한이 필요합니다.
npm install -g heydeer
heydeer loginheydeer login은 링크와 코드를 출력합니다. 링크를 열고 GitHub로 HeyDeer에 로그인한 뒤 코드를 입력하세요. 페이지에 로그인 요청이 어디서 왔는지 표시되므로, 허용하기 전에 내 컴퓨터인지 확인하세요.
| 명령 | 동작 |
|---|---|
heydeer login | 이 컴퓨터에서 HeyDeer에 로그인합니다. |
heydeer status | CLI가 누구로 동작하는지 표시합니다. |
heydeer logout | 이 컴퓨터에서 로그아웃합니다. |
heydeer --version | 설치된 CLI 버전을 표시합니다. |
CLI는 로그인 정보를 ~/.config/heydeer/credentials.json에, Windows에서는 %APPDATA%\heydeer에 저장합니다. 로그인은 마지막으로 사용한 뒤 30일, 최대 90일 동안 유지되며, 만료되면 heydeer login을 다시 실행하세요.
변경 사항 검토하기
저장소 안에서 변경 사항의 목적을 한 문장으로 적어 검토를 실행하세요.
heydeer review "Retry failed uploads. Fixes #123."HeyDeer는 브랜치의 커밋과 추적 중인 파일의 커밋하지 않은 변경 사항을 origin 기본 브랜치와의 병합 기준점에 대해 검토합니다. 설명은 풀 리퀘스트 설명처럼 읽으며, 언급된 이슈까지 포함해 코드와 대조합니다. 설명이 길다면 파일에 작성해 --description-file로 전달하세요.
CLI는 저장소, 기준, 브랜치, 검토 깊이를 보여 주고 전송할 파일을 나열한 뒤 검토 진행 상황을 따라갑니다. 검토가 끝나면 각 발견 사항을 심각도, 파일, 줄과 함께 출력합니다.
옵션
| 옵션 | 동작 |
|---|---|
--description-file <path> | 설명을 명령줄 대신 파일에서 읽습니다. |
--base <ref> | 다른 브랜치나 커밋과 비교합니다. 그 브랜치를 대상으로 하는 작업에 사용하세요. |
--include-untracked | 아직 Git에 추가하지 않은 새 파일도 검토합니다. gitignore된 파일은 제외됩니다. |
--depth standard|deep | 이번 검토만 저장소와 다른 검토 깊이로 실행합니다. 심층은 유료 플랜에서 사용할 수 있습니다. |
--full | 브랜치의 마지막 검토 이후 변경 사항뿐 아니라 모든 변경 사항을 검토합니다. |
--dry-run | 전송될 파일과 내 컴퓨터에 남는 파일을 나열합니다. 로그인하거나 검토를 시작하지 않습니다. |
--json | 완료된 검토를 스크립트와 코딩 에이전트용 JSON으로 출력합니다. |
내 컴퓨터에 남는 것
컴퓨터 밖으로 나가는 것은 병합 기준점 이후의 diff와 설명뿐이며, 나머지 코드는 HeyDeer가 GitHub에서 읽습니다. CLI는 다음 파일을 검토에서 제외하고 Left on this machine 아래에 나열합니다.
- .env 파일과 개인 키 같은 자격 증명 파일.
- 알려진 형식의 자격 증명이 포함된 변경 사항.
- 바이너리 파일.
- 파일 하나에서 1MB를 넘는 변경 사항.
모든 변경 사항을 합쳐 diff 최대 32MB까지 가능합니다. 그보다 크면 더 가까운 --base를 지정하거나 풀 리퀘스트에서 검토하세요. --dry-run을 실행하면 전송 전에 정확한 목록을 볼 수 있습니다.
수정한 뒤 다시 실행하기
브랜치를 검토할 때마다 지난 검토에서 남은 발견 사항을 다시 확인하므로, 다음 실행에서 수정으로 어떤 것이 해결되었는지 알 수 있습니다.
저장소에서 새 변경 사항만 검토가 켜져 있으면, 이후 브랜치 검토는 마지막 전체 검토 이후의 변경 사항만 다룹니다. 이런 검토가 세 번 이어지거나 변경 사항 대부분이 그 검토 이후의 새 변경이 되면, 다음 검토는 모든 변경 사항을 다시 다룹니다. --full을 전달하면 언제든 전체를 검토합니다. 마지막 검토 이후 바뀐 것이 없으면 CLI가 알려 주고 검토를 시작하지 않습니다.
스크립트와 코딩 에이전트에서 사용하기
--json을 사용하면 완료된 검토는 하나의 JSON 객체로 표준 출력에, 진행 상황은 표준 오류에 출력됩니다. 각 발견 사항에는 심각도, 제목, 파일과 줄, 그리고 설명 본문이 있습니다.
Claude Code, Codex, Cursor가 풀 리퀘스트를 열기 전에 자신의 작업을 검토하게 하려면 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.CLI는 다음 코드 중 하나로 종료됩니다.
| 종료 코드 | 의미 |
|---|---|
| 0 | 검토가 끝났습니다. 발견 사항이 있든 없든 마찬가지입니다. |
| 1 | 검토가 실패했거나, 변경된 파일이 모두 내 컴퓨터에 남아야 했습니다. |
| 2 | 명령이나 옵션이 올바르지 않습니다. |
| 130 | Ctrl+C로 취소했습니다. |
완료된 검토는 발견 사항 유무와 관계없이 0으로 종료되므로, 브랜치가 준비되었는지는 JSON의 발견 사항을 읽어 판단하세요.
크레딧
로컬 검토는 해당 저장소를 포함하는 설치의 워크스페이스 크레딧을 사용하며, 모든 저장소에서 비공개 코드로 청구됩니다. 드라이 런과 마지막 검토 이후 바뀐 것이 없는 실행은 크레딧을 사용하지 않습니다. 한 사람이 한 시간에 로컬 검토를 최대 30회 시작할 수 있습니다. Ctrl+C를 누르면 HeyDeer의 검토도 취소되며, 두 번 누르면 CLI가 즉시 멈춥니다.