GitHubのCLI「gh」の使い方

GitHubは、ソフトウェア開発のためのオンラインプラットフォームでありGitというバージョン管理システムを使ってコードを管理することができます。
GitHubではリポジトリと呼ばれるプロジェクトの保存場所を作成し、そこにコードやドキュメントなどのファイルをアップロードしたり、他の開発者と共有したりすることができます。
また、プルリクエストやイシューといった機能を使ってコードのレビューやフィードバック、バグの報告や修正などのコラボレーションを行うこともできます。

GitHubでは、ブラウザからWebサイトにアクセスして操作することが一般的ですが実はコマンドラインからもGitHubを操作することができます。
そのためにはGitHub CLIというツールを使います。
GitHub CLIはGitHub公式が提供するコマンドラインツールであり、ghというコマンドでGitHubの様々な機能を利用することができます。
例えば、ghコマンドを使えばリポジトリの作成やクローン、プルリクエストやイシューの作成や閲覧などを行うことができます。

この記事では、GitHub CLIの利用方法を主にUbuntu上で利用するために紹介します。まずは、インストール方法から見ていきましょう。

GitHub CLIのインストール方法

Ubuntu上でGitHub CLIをインストールするには、以下の手順を実行します。

1 ターミナルを開きます。


2 以下のコマンドを入力して、公開鍵を取得します。

@bash
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-key C99B11DEB97541F0


3 以下のコマンドを入力して、パッケージリポジトリを追加します。

@bash
sudo apt-add-repository https://cli.github.com/packages


4 以下のコマンドを入力して、パッケージリストを更新します。

@bash
sudo apt update


5 以下のコマンドを入力して、GitHub CLIをインストールします。

@bash
sudo apt install gh

以上でインストールは完了です。
gh コマンドが使えるかどうか確認するには、以下のコマンドを入力してみましょう。

@bash
gh --version

正しくインストールされていれば、以下のような出力が表示されます。

gh version 2.3.0 (2021-11-04)

https://github.com/cli/cli/releases/tag/v2.3.0


GitHub CLIでGitHubにログインする

GitHub CLIを使う前に、自分のGitHubアカウントにログインする必要があります。
ログインするには、以下の手順を実行します。

1 ターミナルで任意のghコマンドを入力します。例えば、

@bash
gh pr list


2 以下のようなメッセージが表示されるので、Enterキーを押します。

Notice: authentication required

Press Enter to open github.com in your browser...


3 ブラウザが開き、GitHub CLIへのアクセス許可画面が表示されるので、「Authorize github」ボタンをクリックします。


そうすればログインは完了です。

これでghコマンドが使えます。

主に使うコマンド

リポジトリのクローン

gh repo clone [username]/[reponame]


リポジトリの作成

gh repo create


Issueの作成

gh issue create


Pull Requestの作成

gh pr create --base [into_branch] --head [from_branch] --title "[title]" --body "[body]"
最新の投稿

スポンサーリンク

kstdx
中学生。自称エンジニア。見せられる程度のデザイン力はあるかなと自負しています。現在Twitterが凍結されている。おかねほしい。