gh コマンド(GitHub CLI)

プログラミング

gh コマンド(GitHub CLI)は、ブラウザを開かずにターミナル(黒い画面)から直接 GitHub を操作できる公式のコマンドラインツールです。 [1, 2]

通常、プルリクエストの作成や Issue の確認などは GitHub の Web サイトで行いますが、gh コマンドを使うことで、いつものコード開発画面(VS Code などのターミナル)から離れることなく、すべての操作をキーボードだけで完結できます。 [1, 2, 3]


何ができるの?(主な機能)

GitHub で行う主要な手続きのほとんどに対応しています。 [4]

  • プルリクエスト(PR)の操作
    • gh pr create:プルリクエストを瞬時に作成する
    • gh pr checkout <PR番号>:レビューしたい PR のコードをローカルに持ってくる
    • gh pr merge:ターミナルからそのままマージする [4, 5, 6]
  • Issue(課題)の管理
    • gh issue list:未解決の課題一覧を表示する
    • gh issue create:新しいバグ報告やタスクを作成する [4]
  • リポジトリの操作
    • gh repo clone <リポジトリ名>:URL をコピーしてこなくても、名前だけでクローンできる
    • gh repo create:新しいリモートリポジトリを瞬時に作成する [4, 7, 8]
  • GitHub Actions の確認
    • gh run list / gh run watch:CI/CD(自動テストなど)の実行状況をリアルタイムに監視する [1]

git コマンドとの違い

役割が完全に異なります。 [2]

コマンド操作の対象主な役割
gitローカルのソースコード変更の記録(commit)、ブランチの切り替え(checkout)など
ghGitHub(Webサービス)の機能プルリク作成、Issue管理、Actionsの監視、Webページの操作

💡 導入するメリット

  1. 画面の切り替えが減る:ブラウザとエディタを行き来する時間がなくなり、開発に集中できます。 [4, 5]
  2. 自動化スクリプトが組める:シェルスクリプトなどと組み合わせれば、「コードを変更して、プッシュして、プルリクを作って、特定のラベルを貼る」といった一連の作業を自動化できます。 [2, 4]
  3. ブラウザで開くのも一瞬:CLI で確認していて「やっぱり Web 画面で見たい」と思ったら、gh pr view --web と打つだけで該当ページがブラウザで開きます。 [9, 10]

詳しい使い方やインストール方法は、GitHub CLI 公式ドキュメント から確認できます。 [4, 11]


もし使ってみたい場合は、お使いの パソコンのOS(Mac、Windows、Linuxなど) を教えてください。それぞれのインストール手順や、最初に必要なログイン認証(gh auth login)の手順をご案内します。 [1]

[1] https://tech-lab.sios.jp

[2] https://foxcode.jp

[3] https://site.tokiukaze.com

[4] https://docs.github.com

[5] https://engineer.retty.me

[6] https://developer.so-tech.co.jp

[7] https://docs.github.com

[8] https://www.youtube.com

[9] https://qiita.com

[10] https://zenn.dev

[11] https://www.youtube.com

タイトルとURLをコピーしました