GitHub CLI (gh)

概要

GitHub CLI (gh) の操作とワークフローに関する専門的なガイダンス。このスキルはプルリクエスト管理、イシュー追跡、リポジトリ操作、ワークフロー自動化、codespace 管理など、コマンドライン GitHub 操作全般で使用します。

主な機能:

• ターミナルからプルリクエストを作成・管理
• イシューを効率的に追跡・整理
• GitHub 全体を検索 (リポジトリ、イシュー、PR)
• ラベルとプロジェクト組織を管理
• GitHub Actions ワークフローをトリガー・監視
• codespaces で作業
• リポジトリ操作とリリースを自動化
• ブラウザでリポジトリ、PR、ファイルを閲覧

セーフティルール

重要: このスキルは破壊的な gh CLI 操作を決して使用しません。

このスキルは安全、読み取り専用、または可逆的な GitHub 操作にのみ焦点を当てています。以下のコマンドは 禁止 であり、絶対に 使用してはいけません:

永続的に破壊的なコマンド:

• gh repo delete - リポジトリ削除
• gh repo archive - リポジトリアーカイブ
• gh release delete - リリース削除
• gh release delete-asset - アセット削除
• gh run delete - ワークフロー実行削除
• gh cache delete - キャッシュ削除
• gh secret delete - シークレット削除
• gh variable delete - 変数削除
• gh label delete - ラベル削除
• gh ssh-key delete - SSH キー削除 (ユーザーをロックアウトできる)
• gh gpg-key delete - GPG キー削除
• gh codespace delete - Codespace 削除
• gh extension remove - エクステンション削除
• gh gist delete - Gist 削除
• 破壊的なコマンドで xargs を使用した一括削除操作
• シェルコマンド: rm -rf (一時ファイルのクリーンアップを除く)

許可される操作:

• リソース作成 (PR、イシュー、リリース、ラベル、リポジトリ)
• 表示と一覧表示 (ステータス、ログ、情報、検索)
• 既存リソースの更新と編集
• PR/イシューのクローズ (可逆的 - 再度開くことができる)
• プルリクエストのリバート (新しいリバート PR を作成)
• ワークフロー実行のキャンセル (データを削除せずに実行を停止)
• プルリクエストのマージ (適切なレビュー後)
• 読み取り専用 git 操作 (git status、git log、git diff)

インストール & セットアップ

# GitHub にログイン
gh auth login

# ログインして OAuth コードをクリップボードに自動コピー
gh auth login --clipboard

# 認証ステータス確認
gh auth status

# JSON 出力での認証ステータス確認
gh auth status --json

# gh を認証情報ヘルパーとして git を設定
gh auth setup-git

プルリクエスト

PR の作成

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

# タイトルと本文で PR を作成
gh pr create --title "Add feature" --body "Description"

# 特定のブランチに PR を作成
gh pr create --base main --head feature-branch

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

# 現在のブランチから PR を作成
gh pr create --fill  # コミットメッセージを使用

# Copilot Code Review 付き PR を作成
gh pr create --reviewer @copilot

PR の表示

# PR を一覧表示
gh pr list

# 自分の PR を一覧表示
gh pr list --author @me

# PR 詳細を表示
gh pr view 123

# ブラウザで PR を表示
gh pr view 123 --web

# PR diff を表示
gh pr diff 123

# 特定のファイルを除外して PR diff を表示
gh pr diff 123 --exclude "*.lock"

# PR ステータスを確認
gh pr status

PR の管理

# PR をローカルにチェックアウト
gh pr checkout 123

# PR をレビュー
gh pr review 123 --approve
gh pr review 123 --comment --body "Looks good!"
gh pr review 123 --request-changes --body "Please fix X"

# Copilot Code Review をリクエスト
gh pr edit 123 --add-reviewer @copilot

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

# PR をクローズ
gh pr close 123

# PR を再度開く
gh pr reopen 123

# ドラフト PR を準備完了に
gh pr ready 123

# PR ブランチをベースブランチで更新
gh pr update-branch 123

# マージ済み PR をリバート (新しいリバート PR を作成)
gh pr revert 123

PR チェック

# PR チェックを表示
gh pr checks 123

# PR チェックを監視
gh pr checks 123 --watch

イシュー

イシューの作成

# イシューをインタラクティブに作成
gh issue create

# タイトルと本文でイシューを作成
gh issue create --title "Bug report" --body "Description"

# ラベル付きでイシューを作成
gh issue create --title "Bug" --label bug,critical

# イシューを割り当て
gh issue create --title "Task" --assignee @me

イシューの表示

# イシューを一覧表示
gh issue list

# 自分に割り当てられたイシューを一覧表示
gh issue list --assignee @me

# ラベルで一覧表示
gh issue list --label bug

# 詳細検索
gh issue list --search "is:open label:bug sort:created-desc"

# イシューの詳細を表示
gh issue view 456

# ブラウザで表示
gh issue view 456 --web

イシューの管理

# イシューをクローズ
gh issue close 456

# 重複として閉じる (元のイシューにリンク)
gh issue close 123 --duplicate-of 456

# イシューを再度開く
gh issue reopen 456

# イシューを編集
gh issue edit 456 --title "New title"
gh issue edit 456 --add-label bug
gh issue edit 456 --add-assignee @user

# イシューにコメント
gh issue comment 456 --body "Update"

# イシューで作業するためのブランチを作成
gh issue develop 456 --checkout

リポジトリ操作

リポジトリ情報

# リポジトリを表示
gh repo view

# ブラウザで表示
gh repo view --web

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

# upstream リモートを追加せずにクローン
gh repo clone owner/repo --no-upstream

# リポジトリをフォーク
gh repo fork owner/repo

# リポジトリを一覧表示
gh repo list owner

リポジトリ管理

# リポジトリを作成
gh repo create my-repo --public
gh repo create my-repo --private

# フォークを同期
gh repo sync owner/repo

# デフォルトリポジトリを設定
gh repo set-default

検索

ユーザーが GitHub リポジトリ、イシュー、またはプルリクエストを検索するよう求めている場合は、references/search.md を参照してください。

ラベル

ユーザーがリポジトリラベルを一覧表示、作成、編集、またはクローンするよう求めている場合は、references/labels.md を参照してください。

Codespaces

ユーザーが GitHub Codespaces を一覧表示、作成、接続、またはファイルを管理するよう求めている場合は、references/codespaces.md を参照してください。

ブラウザで開く

リポジトリ、ファイル、およびリソースをブラウザで開きます。

# 現在のリポジトリをブラウザで開く
gh browse

# 特定のファイルを開く
gh browse src/main.go

# 特定の行でファイルを開く
gh browse src/main.go:42

# ファイルの blame ビューを開く
gh browse --blame src/main.go

# Actions タブを開く
gh browse --actions

# 特定のブランチを開く
gh browse --branch feature

リリース

ユーザーが GitHub リリースを作成、一覧表示、表示、またはダウンロードするよう求めている場合は、references/releases.md を参照してください。

Gists

ユーザーが GitHub gists を作成、一覧表示、表示、または編集するよう求めている場合は、references/gists.md を参照してください。

設定

# デフォルトエディターを設定
gh config set editor vim

# デフォルト git プロトコルを設定
gh config set git_protocol ssh

# 設定を表示
gh config list

# ブラウザを設定
gh config set browser firefox

クイックリファレンス

一般的な gh 操作の一覧:

操作	コマンド	一般的なフラグ
PR を作成	gh pr create	--draft, --fill, --reviewer @copilot
PR を一覧表示	gh pr list	--author @me, --label, --search
PR を表示	gh pr view <number>	--web, --comments
PR をマージ	gh pr merge <number>	--squash, --rebase, --delete-branch
PR をリバート	gh pr revert <number>	--body
イシューを作成	gh issue create	--title, --body, --label
イシューを一覧	gh issue list	--assignee @me, --label, --search
イシューをクローズ	gh issue close <number>	--duplicate-of, --reason
イシューを表示	gh issue view <number>	--web, --comments
リポジトリを閲覧	gh browse	--blame, --actions, --branch
リポジトリをクローン	gh repo clone <repo>	--no-upstream
リポジトリをフォーク	gh repo fork	--clone, --remote
リポジトリを表示	gh repo view	--web
リリースを作成	gh release create <tag>	--title, --notes, --draft
リリースを検証	gh release verify <tag>	--repo
ワークフローを実行	gh workflow run <name>	--ref, --field
実行を監視	gh run watch <id>	--exit-status
リポジトリを検索	gh search repos <query>	--language, --stars
ラベルを作成	gh label create <name>	--color, --description
Codespace を作成	gh codespace create	--repo, --branch

その他のリソース

リファレンスガイド

詳細なパターンと高度な使用方法については、以下を参照してください:

• ワークフロー & アクション - GitHub Actions ワークフロー、実行、キャッシュ管理、CI/CD 統合パターン
• 高度な機能 - エイリアス、API アクセス、エクステンション、シークレット、SSH/GPG キー、組織、プロジェクト、高度なスクリプティング
• 自動化ワークフロー - 一般的な自動化パターン、日次レポート、リリース自動化、チーム協力ワークフロー
• トラブルシューティング - 認証、権限、レート制限、一般的なエラーの解決策

サンプルスクリプト

実用的な自動化スクリプト (examples/ ディレクトリを参照):

• auto-pr-create.sh - 自動化された PR 作成ワークフロー
• issue-triage.sh - 一括イシューラベリングと割り当て
• workflow-monitor.sh - ワークフロー完了を監視・通知
• release-automation.sh - 完全なリリースワークフロー自動化

外部ドキュメント

• 公式マニュアル: https://cli.github.com/manual
• GitHub コミュニティ: https://github.com/cli/cli/discussions
• API ドキュメント: https://docs.github.com/en/rest
• エクステンション マーケットプレース: https://github.com/topics/gh-extension

JSON 出力

ユーザーが --json フラグを使用したいか、正しい gh CLI JSON フィールド名が必要な場合は、references/json-output.md を参照してください。

ヒント

1. 詳細表示のためにブラウザでアイテムを開くには --web フラグを使用
2. パラメータを省略してインタラクティブプロンプトを活用 - ほとんどのコマンドがインタラクティブモードに対応
3. --author、--label、--state でフィルタを適用して一覧を効率的に絞り込む
4. 自動化のために --json フラグを追加してスクリプト可能な出力を有効化
5. 常に --help で有効な JSON フィールド名を確認 - GitHub API と異なります
6. テンプレートリポジトリからスカフォールドするには gh repo create --template を使用
7. チェックをパスした PR に対して gh pr merge --auto で自動マージを有効化