| name | gh |
| description | GitHub(github.com) 작업 시 gh CLI 사용 가이드.
PR 조회/생성/리뷰, 이슈 관리, 코드 검색, 릴리즈 등 GitHub.com 작업에 적용.
Use when: GitHub.com 관련 작업, 개인/오픈소스 repo 작업 요청 시
|
| version | 1.1.0 |
gh CLI — GitHub.com (개인/오픈소스)
원칙
- GitHub.com 작업은
gh CLI로 수행한다 (hostname 지정 불필요, 기본값).
gh api로 REST API 전체에 접근 가능하므로 모든 작업이 가능하다.
환경
- Host:
github.com (기본)
- 인증: keyring 기반 (
gh auth login으로 설정됨)
주요 명령어 레퍼런스
PR 작업
gh pr list
gh pr view <number>
gh pr view <number> --json title,body,reviews,comments
gh pr diff <number>
gh pr checks <number>
gh pr create --title "제목" --body "$(cat <<'EOF'
## Summary
...
EOF
)"
gh pr review <number> --approve
gh pr review <number> --request-changes --body "피드백"
gh pr review <number> --comment --body "코멘트"
라인별 리뷰 코멘트 (pending review 워크플로우)
gh api repos/{owner}/{repo}/pulls/{number}/reviews \
-f event=PENDING
gh api repos/{owner}/{repo}/pulls/{number}/comments \
-f body="코멘트 내용" \
-f path="파일경로" \
-F line=42 \
-f side=RIGHT
gh api repos/{owner}/{repo}/pulls/{number}/reviews/{review_id}/events \
-f event=COMMENT
PR 코멘트 조회
gh api repos/{owner}/{repo}/pulls/{number}/comments
gh api repos/{owner}/{repo}/issues/{number}/comments
이슈 작업
gh issue list
gh issue view <number>
gh issue create --title "제목" --body "내용"
gh search issues "검색어" --repo owner/repo
코드/PR/이슈 검색
gh search code "패턴" --repo owner/repo
gh search prs "검색어" --repo owner/repo
gh search issues "검색어" --repo owner/repo
파일 내용 조회
gh api repos/{owner}/{repo}/contents/{path}?ref={branch}
릴리즈/태그
gh release list
gh release view <tag>
gh api repos/{owner}/{repo}/tags
브랜치/커밋
gh api repos/{owner}/{repo}/branches
gh api repos/{owner}/{repo}/commits/{sha}
gh api repos/{owner}/{repo}/commits?sha={branch}&per_page=10
기타 API 접근
gh api <endpoint> [flags]
gh api repos/{owner}/{repo}/actions/runs
gh api repos/{owner}/{repo}/issues -f title="제목" -f body="내용"
gh api repos/{owner}/{repo}/pulls --paginate
금지 사항
gh pr comment — deny 목록에 등록됨 (실수 방지)
gh pr merge — 승인 없이 머지 금지
git push — deny 목록에 등록됨 (별도 승인 필요)