GitHub CLI コマンドリファレンス

GitHub CLIは、ブラウザ上でのGitHub操作をコマンドラインで実行できるツールです。慣れるまで大変ですが、対話形式に対応していたりと便利なので、使いこなせるようになりたいものです。

※ ver 1.10.3対応済み。

コマンド一覧

各コマンドの詳細とオプションは、公式マニュアルもしくはghコマンドから確認できます。

リポジトリの操作

gh repoから始まるコマンドです。リポジトリのリスト表示や詳細の確認、新規作成、クローン、フォークなどを行えます。

# リポジトリをクローン
$ gh repo clone <[repository]>

# リポジトリを新規作成
$ gh repo create <[repository]>

# リポジトリをフォーク
$ gh repo fork <[repository]> <[option]>

# リポジトリのリストを表示
$ gh repo list <[owner]> <[option]>

# リポジトリの詳細を表示
$ gh repo view <[repository]> <[option]>

プルリクエストの操作

gh prから始まるコマンドです。プルリクエスト関連を操作できます。

# 指定したPRのブランチへ切り替え
$ gh pr checkout <[number> | <url> | <branch]> <[option]>

# PRのCIステータスを表示
$ gh pr checks <[number> | <url> | <branch]> <[option]>

# PRを閉じる
$ gh pr close <[number> | <url> | <branch]> <[option]>

# PRにコメントを投稿
$ gh pr comment <[number> | <url> | <branch]> <[option]>

# PRを新規作成
$ gh pr create <[option]>

# PRの差分を確認
$ gh pr diff <[number> | <url> | <branch]> <[option]>

# PRを編集 (タイトル・概要・ラベル・担当者など)
$ gh pr edit <[number> | <url> | <branch]> <[option]>

# PRのリストを表示
$ gh pr list <[option]>

# PRをマージ
$ gh pr merge <[number> | <url> | <branch]> <[option]>

# PRをレビュー段階としてマーク
$ gh pr ready <[number> | <url> | <branch]> <[option]>

# 閉じたPRを再開
$ gh pr reopen <[number> | <url> | <branch]> <[option]>

# PRにレビューを追加 (コメント・承認・修正依頼)
$ gh pr reopen <[number> | <url> | <branch]> <[option]>

# 各PRのステータスを表示
$ gh pr status <[option]>

# PRの詳細を表示
$ gh pr view <[option]>

イシューの操作

gh issueから始まるコマンドです。イシュー関連を操作できます。

# イシューを閉じる
$ gh issue close <[number> | <url]> <[option]>

# イシューにコメントを追加する
$ gh issue comment <[number> | <url]> <[option]>

# 新しいイシューを作成する
$ gh issue create <[option]>

# イシューを削除する
$ gh issue delete <[number> | <url]> <[option]>

# イシューを編集する
$ gh issue edit <[number> | <url]> <[option]>

# イシューの一覧を表示する
$ gh issue list <[option]>

# クローズしたイシューを再度開く
$ gh issue reopen <[number> | <url]> <[option]>

# イシューのステータスを表示する
$ gh issue status <[option]>

# イシューを別のリポジトリに移動する
$ gh issue transfer <[number> | <url]> <[destination-repo]> <[option]>

# イシューの詳細情報を表示する
$ gh issue view <[number> | <url]> <[option]>

GitHub CLIのアップデート

GitHub CLI本体の更新方法もまとめておきます。

Windows

# WinGet
$ winget install gh

# scoop
$ scoop update gh

# Chocolatey
$ choco upgrade gh

macOS

# Homebrew
$ brew upgrade gh

# MacPorts
$ sudo port selfupdate && sudo port upgrade gh

Linux

# Debian, Ubuntu Linux (apt)
$ sudo apt update
$ sudo apt install gh

# Fedora, CentOS, Red Hat Enterprise Linux (dnf)
$ sudo dnf update gh

# openSUSE/SUSE Linux (zypper)
$ sudo zypper ref
$ sudo zypper update gh