GitHub CLI (gh) スキル は何をしますか?
gh CLI を使用して、ターミナルから GitHub リポジトリ、Issue、プルリクエスト、GitHub Actions ワークフローと対話します。
前提条件
g がインストールされ、認証されていることを確認します:
g --version
g auth status
認証されていない場合は、gh auth login を実行し、プロンプトに従ってください。
コアワークフロー
Issue 管理
# Issue の一覧表示
g issue list # 現在のリポジトリのオープン Issue
g issue list --state all # クローズされた Issue も含むすべて
g issue list --assignee @me # 自分に割り当てられた Issue
g issue list --label "bug" # ラベルでフィルタ
# Issue の作成
g issue create -t "タイトル" -b "説明"
g issue create -t "タイトル" --label "bug,priority:high" --milestone "milestone-1"
g issue create # インタラクティブモード
# Issue の表示/更新
g issue view 123 # Issue の詳細を表示
g issue view 123 --web # ブラウザで開く
g issue edit 123 --add-label "in-progress"
g issue close 123
g issue reopen 123
# コメントの追加
g issue comment 123 -b "現在取り組んでいます"
ブランチとコミットのワークフロー
# 機能/修正ブランチを作成
git checkout -b feature/my-feature
git checkout -b fix/issue-123
git checkout -b draft/wip-experiment
# 変更をステージしてコミット
git add .
git commit -m "feat: 新機能を追加"
git commit -m "fix: Issue #123 を修正"
# ブランチをリモートにプッシュ
git push -u origin feature/my-feature
プルリクエスト管理
# PR を作成 (複数の方法)
g pr create # インタラクティブモード
g pr create --fill # コミットから自動入力
g pr create --draft # ドラフトとして作成
g pr create --draft --fill # ドラフト + 自動入力
g pr create -t "タイトル" -b "説明" -B main
g pr create --label "review-needed" --assignee @me
# PR の一覧表示
g pr list # オープン PR
g pr list --assignee @me # 自分の PR
g pr list --search "review-requested:@me" # レビュー依頼中の PR
g pr list --draft # ドラフト PR のみ
# PR の詳細表示
g pr view 45 # ターミナルで PR を表示
g pr view 45 --web # ブラウザで開く
コードレビューワークフロー
# PR をローカルでチェックアウト
g pr checkout 45 # PR ブランチをローカルにチェックアウト
# 変更をレビュー
g pr diff 45 # PR の差分を表示
g pr diff # カレントブランチの PR の差分を表示
# レビューコメントを追加
g pr comment 45 -b "LGTM、42行目に小さな提案があります"
g pr comment -b "テストを追加してください" # カレントブランチの PR にコメント
# 正式なレビューを送信
g pr review 45 --approve
g pr review 45 --request-changes -b "エラーハンドリングを修正してください"
g pr review 45 --comment -b "全体的には良いですが、いくつか提案があります"
# マージ
g pr merge 45 # インタラクティブマージ
g pr merge 45 --squash # スクワッシュマージ
g pr merge 45 --rebase # リベースマージ
g pr merge 45 --merge # 標準マージコミット
g pr merge 45 --auto # チェックが通過したら自動マージ
既存 PR の更新
g pr edit 45 --title "新しいタイトル"
g pr edit 45 --body "更新された説明"
g pr edit 45 --base develop
g pr edit 45 --add-label "ready-for-review"
g pr ready 45 # 準備完了 (ドラフト解除)
GitHub Actions ワークフロー管理
# ワークフロー実行の一覧表示
g run list # 最近のワークフロー実行
g run list --workflow=ci.yml # 特定のワークフロー
g run list --status=failure # 失敗した実行のみ
# ワークフロー実行の詳細表示
g run view # インタラクティブな実行選択
g run view 12345 # 特定の実行
g run view 12345 --web # ブラウザで開く
# ワークフローのトリガー
g workflow run ci.yml # デフォルトブランチで実行
g workflow run ci.yml --ref feature/x # 特定のブランチで実行
g workflow run ci.yml -f key=value # 入力パラメータ付き
# 失敗したジョブの再実行
g run rerun 12345 # すべてのジョブを再実行
g run rerun 12345 --failed # 失敗したジョブのみ再実行
# ジョブログの表示
g run view 12345 --log # すべてのログ出力
g run view 12345 --log-failed # 失敗したジョブのログのみ
# 実行中のワークフローを監視
g run watch # 現在の実行を監視
g run watch 12345 # 特定の実行を監視
よく使うフラグ一覧
| フラグ | 説明 |
|---|---|
-R, --repo OWNER/REPO | 異なるリポジトリを対象にする |
-B, --base | PR のベースブランチ |
-H, --head | PR のヘッドブランチ |
-t, --title | Issue/PR のタイトル |
-b, --body | Issue/PR の本文/説明 |
-l, --label | ラベル (カンマ区切り) |
-a, --assignee | アサインするユーザー名 |
-m, --milestone | マイルストーン名 |
--draft | ドラフト PR として作成 |
--fill | コミットメッセージから自動入力 |
--web | ブラウザで開く |
-y, --yes | 確認プロンプトをスキップ |
環境変数
export GH_TOKEN="ghp_xxxx" # 個人アクセストークン
export GH_HOST="github.example.com" # GitHub Enterprise インスタンス
export GH_REPO="owner/repo" # デフォルトリポジトリ
ヒントと注意点
マークダウンを含む複数行の説明文
コードブロックやバッククォートを含む長い説明文で Issue や PR を作成する場合、ヒアドキュメントはシェルの解釈により失敗する可能性があるため避けてください。代わりに以下のようにします:
# ステップ 1: 説明文を一時ファイルに書き込む (bash の外で)
# ステップ 2: 一時ファイルから作成
g issue create -t "タイトル" -b "$(cat temp_description.txt)"
# ステップ 3: クリーンアップ
rm temp_description.txt
これにより、以下の問題を回避できます:
- コードブロック内のバッククォートがコマンド置換と競合する
- 特殊文字がシェルによって解釈される
- ヒアドキュメントのデリミタ競合
既存ファイルからの説明文の読み込み
マークダウンの計画ファイルから Issue や PR を作成する場合:
# ファイルベースの説明には body-file フラグを使用
g issue create -t "タイトル" --body-file docs/plans/my-plan.md
g pr create -t "タイトル" --body-file docs/plans/my-plan.md
詳細リファレンス
包括的なコマンドオプションと例については、references/commands.md を参照してください。