ドキュメント
Computer Science
Linux
ツール
開発ツール
gh

gh

GitHub 公式(こうしき) コマンドラインツール。端末(たんまつ) から直接(ちょくせつ) GitHub を操作(そうさ)

インストール 

# macOS
brew install gh

# Ubuntu/Debian
sudo apt install gh

# Arch Linux
sudo pacman -S github-cli

認証 

# インタラクティブログイン
gh auth login

# 認証状態を確認
gh auth status

# ログアウト
gh auth logout

リポジトリ操作 

# リポジトリをクローン
gh repo clone owner/repo

# 新しいリポジトリを作成
gh repo create my-project --public
gh repo create my-project --private

# ブラウザでリポジトリを開く
gh repo view --web

# リポジトリ情報を表示
gh repo view owner/repo

Pull Request

PR を作成 

# インタラクティブ作成
gh pr create

# タイトルと内容を指定
gh pr create --title "Feature: Add login" --body "Description"

# ドラフト PR を作成
gh pr create --draft

# レビュアーを指定
gh pr create --reviewer user1,user2

PR を表示・管理 

# PR を一覧表示
gh pr list

# PR 詳細を表示
gh pr view 123

# ブラウザで開く
gh pr view 123 --web

# PR ブランチに切り替え
gh pr checkout 123

# PR をマージ
gh pr merge 123
gh pr merge 123 --squash
gh pr merge 123 --rebase

# PR をレビュー
gh pr review 123 --approve
gh pr review 123 --request-changes --body "修正が必要..."

Issue 

# issue を一覧表示
gh issue list

# issue を作成
gh issue create --title "Bug: ..." --body "Description"

# issue を表示
gh issue view 456

# issue をクローズ
gh issue close 456

Workflow (GitHub Actions) 

# workflow を一覧表示
gh workflow list

# workflow 実行状態を表示
gh run list

# 特定の実行を表示
gh run view 123456

# 再実行
gh run rerun 123456

# 実行ログを表示
gh run view 123456 --log

Gist 

# gist を作成
gh gist create file.txt

# 公開 gist を作成
gh gist create file.txt --public

# gist を一覧表示
gh gist list

API 操作 

# GitHub API を直接呼び出し
gh api repos/owner/repo

# POST リクエスト
gh api repos/owner/repo/issues --method POST -f title="Bug" -f body="Description"

# jq で出力を処理
gh api repos/owner/repo/pulls | jq '.[].title'

エイリアス設定 

# エイリアスを設定
gh alias set pv 'pr view'

# エイリアスを使用
gh pv 123

# エイリアスを一覧表示
gh alias list
jq