ghコマンドでGitHubをCLIで操作する

はじめに

先日インストールしたGitHub CLI(通称ghコマンド)が非常に便利でした。何故今まで使っていなかったのか分からないレベルで便利だったので、今回自分なりの使い方をまとめてみました。

インストール・設定

下記コマンドでGitHub CLIをインストールします。

$ brew install gh

初期設定だとエディタがnanoになっていますので、Vimに変更します。

$ gh config set editor vim

初期設定だとghコマンドのタブ補完が行われないので、下記のコードを.zshrcに追記します。

eval "$(gh completion -s zsh)"

また初めてghでリポジトリを操作しようとすると認証設定を求められるかと思いますが、ウィザードに従って設定を行って下さい。コンソールに出力されるコードをブラウザに入力すると認証が完了します。

主な使い方

私はもっぱらプルリクの作成・編集・閲覧に使用します。

プルリク作成

プルリクを作成する際は作業ブランチに移動して下記コマンドを実行します。

$ gh pr create
※ブランチ選択、タイトル入力、Body入力を行う

プルリク編集

プルリクを編集する際は下記コマンドを実行します。

$ gh pr edit

編集する項目にスペースでチェックを入れてからEnterを押すと編集が始まります。レビュアーも指定出来るのが素晴らしいですよね。

プルリク確認

プルリクの内容を確認するには下記のコマンドを実行します。

$ gh pr view

プルリクの状態を確認するには下記のコマンドを実行します。例えばGitHub ActionsにフックされたCIの実行結果などの確認に使います。

$ gh pr status
$ gh pr checks ← より詳細にCIの結果を確認する場合はこっち

Files changedを確認するには下記のコマンドを実行します。

$ gh pr diff

プルリク一覧

下記コマンドを実行するとOpenな状態のプルリクの内30件を出力します。

$ gh pr list

プルリクをブラウザで確認

プルリクページをブラウザで開くには次のコマンドを実行します。
※プルリクのIDは先程のgh pr viewで取得出来ます。

$ gh browse [PRかISSUEのID]

ヘルプの引き方

使い方を忘れた時はヘルプの引き方を覚えておくと何かと楽です。

$ gh pr --help
$ gh pr list --help

コマンドやサブコマンドのあとに--helpオプションを付与すると、状況に応じて使い方や例を確認出来ます。またより詳細な情報を得るためのリンクも教えてくれますので積極的に活用して下さい。

終わりに

プルリクのレビューも出来るのですが、そこはまだ試していないです。自分はLGTM画像を貼り付けたりしたいのでレビューだけはブラウザで行うかもしれません。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA