GitHub CLI
GitHubの情報の表示・操作時に、ブラウザを開かずとも、CLI上で情報の出力や操作を可能にしてくれる、GitHub CLIがあります。こちらのツールを用いて様々な作業効率化を図っていきたいと思い、導入してみます。
プランや運用種別による初期設定の違い
使用しているGitHubのプランや運用種別によって、GitHub CLIの認証方法が異なっています。
今回はGitHub Enterprise ServerにGitHub CLIをインストールし、認証まで行う方法について解説します。
環境:MacOS Sonoma14.3.1
GitHub Enterprise Serverを利用している
本記事、また公式Docsを参考にしてください
GitHub Free / Proを利用している
公式Docs
https://docs.github.com/ja/github-cli/github-cli/quickstart
GitHub Enterprise Cloudを利用している
公式Docs
https://docs.github.com/ja/enterprise-cloud@latest/github-cli/github-cli/quickstart
設定手順
■ インストール
brewを使用してインストールします。
brew install gh
■ ログイン設定（hostnameの入力）
GitHubの任意のリポジトリをブラウザで開き、URLバーに表示されている、https://${hostname.com}/repository-name
の${hostname.com}の部分を下記コマンドに貼り付けて実行してください。
gh auth login --hostname ${hostname.com}
コマンドを実行すると複数の質問に答えていく形になります。
■ プロトコル選択
接続するプロトコルの方式をssh or HTTPSで選択します。→ HTTPSを選択
? What is your preferred protocol for Git operations on this host?
> ssh / HTTPS
■ GitHubクレデンシャルを使用した認証の確認 → Yを選択
? Authenticate Git with your GitHub credentials?
> Yes
■ ブラウザを用いた認証を行うか → Enter
? How would you like to authenticate GitHub CLI? Login with a web browser
■ 一時的な認証コードを発行されるのでメモしておく（XXXX-XXXX）
! First copy your one-time code: XXXX-XXXX
■ 下記メッセージが出たら、Enterを押下
Press Enter to open ${hostname.com} in your browser...
■ ブラウザが開きます
・先ほどの認証コードを入力してContinueを押下。
・下記のように表示されれば、認証できています。
・ターミナル上では、下記メッセージが出ており、こちらでも認証完了を確認することができました。
✓ Authentication complete.
- gh config set -h ${hostname.com} git_protocol https
✓ Configured git protocol
✓ Logged in as ${your.github.account.name}
動作確認
試しに、下記コマンドを作業ディレクトリで実行してみましょう
（PullRequestを一覧出力してくれる）
gh pr list
下記のように、PullRequestの一覧を表示してくれました
ブラウザを毎回開いてPullRequestを見に行かずとも、ターミナル内で即座に一覧を見ることができます
ID TITLE BRANCH CREATED AT
#29 Hoge CSSの修正... fix/design about 6 days ago
#30 Hoge HTMLの修正... fix/design about 7 days ago
終わりに
今回はGitHub Enterprise ServerでGitHub CLIが使えるようになるまでの手順を紹介しました。
インストール後のログインコマンドgh auth login --hostname ${hostname.com}が今回のミソとなる部分です。
次は、GitHub CLI活用法や生産性向上についての記事が書ければと思います！