Githubつかっているけど、もっと便利に使えないかなー
本記事では上記の悩みを解決します。
Web開発・制作現場ではおなじみのGithub。僕も多分に漏れずにつかっています。
VSCodeの拡張機能も多くあり、効率的に使うための方法は多くあるのですが最近Github CLIというのを使い始めてとても便利で開発効率があがるなーと思った記事にて解説しようと思います。
本記事の信頼性
30歳から異業種への転職をして、Shopify Experts企業で1年半ほどフルリモートで勤務していました。
現在は名古屋の自社開発企業のフロントエンドエンジニアしています。フリーランスとしても活動しています。
Github CLIとは
Github CLIとはコマンドライン上でGithubの操作を行うことができるCLIのツールです。
公式ドキュメント
プルリクエストやissueの他、色々な機能があります。
Github CLIの導入方法
公式ドキュメントに沿って導入を行います。
Github CLIをインストールする
Github CLIを使うためにHomebrewをインストールする必要があるのでインストールできていない人はインストールしておきましょう。(省略)
$ brew -v //brew -vでHomebrewが入っているか確認
Homebrew 4.1.18
$ brew install gh
これでGithub CLIのインストールが完了です。
次に、認証を行います。
認証
認証にはいくつか方法があるようです。認証がすんでいないといくつか質問されるので回答していって認証を完了させる必要があります。
$ gh auth login ✘ 130
? What account do you want to log into? GitHub.com
? You're already logged into github.com. Do you want to re-authenticate? Yes
? What is your preferred protocol for Git operations? SSH
? Upload your SSH public key to your GitHub account? /Users/dev_oka/.ssh/id_rsa.pub
? Title for your SSH key: GitHub CLI
? How would you like to authenticate GitHub CLI? Login with a web browser
! First copy your one-time code: E166-C8DB
Press Enter to open github.com in your browser...
✓ Authentication complete.
- gh config set -h github.com git_protocol ssh
✓ Configured git protocol
✓ SSH key already existed on your GitHub account: /Users/dev_oka/.ssh/id_rsa.pub
✓ Logged in as XXXXXXX-XXXXX
認証が完了したらGithubの適当な作業ディレクトリ(Github管理している)に移動して動作するのか確認してみましょう。
$ gh pr list
no open pull requests in XXXXXXXXXX(リポジトリの名前)
プルリクエストの一覧を確認できるコマンドで確認しまし。プルリクエスト自体存在しないようですが、接続は問題ないことが確認できますね^^
便利なコマンド一覧
僕も最近使い始めたばかりなので、自分がつかっているものプラス、今後使えそうだなーというものの一覧をまとめていきます。
リポジトリの操作
# 新しいリポジトリを作成
$ gh repo create [<name>] [flags]
# リポジトリを削除
$ gh repo delete [<repository>] [flags]
# リポジトリの一覧表示
$ gh repo list [<owner>] [flags]
プルリクエストの操作
# プルリクエストをチェックアウト
$ gh pr checkout {<number> | <url> | <branch>} [flags]
# プルリクエストを作成
$ gh pr create [flags]
# プルリクエストの一覧表示
$ gh pr list [flags]
まとめ
効率的に開発できることは生産性に直結します。
日々便利なものは取り入れていけるといいですね!