はじめてのghインストール:GitHubのghコマンドとは?最短で解説

GitHub

GitHubで作業していると、途中で「gh って入ってないとできない」と言われる場面があります。
たとえば、PR作成やレビュー、Issue操作、GitHub Actionsの確認などを、ブラウザを開かずにターミナルからやれるのが gh(GitHub CLI)です。

この記事では「使い方の細かい話」よりも、まず入れて動く状態にするところまでをまとめます。

gh が必要になるのはどんな時?

次みたいな場面で「gh を入れてください」と言われがちです。

  • GitHub Actions をターミナルから確認したい
  • PRを作成するときに gh pr create を使う手順が書かれていた
  • CIのログ確認が gh run view 前提だった
  • ローカルからGitHubにログイン(認証)して操作したい

「え、入ってないとダメなの?」となったら、この記事の手順だけやればOKです。

まずはインストールできているか確認

ターミナルでこれを実行します。

gh –version

  • バージョンが表示されれば、もうインストール済みです
  • gh: command not found などが出たら、未インストールなので次へ

インストール方法(OS別)

Windows(いちばん簡単:winget)

Windows 10/11 で winget が使えるならこれが楽です。

winget install –id GitHub.cli

入ったか確認します。

gh –version

macOS(Homebrew)

brew install gh

確認。

gh –version

Ubuntu / Debian 系

sudo apt update
sudo apt install gh

確認。

gh –version

最初にやること:GitHub にログイン(認証)

インストールしたら、まずログインします。

gh auth login

ここで聞かれる内容はざっくりこうです。

  • GitHub.com か GitHub Enterprise か
  • 認証方法(ブラウザでログインが一番簡単)
  • Git 操作に使うか(Yes推奨)

終わったら状態確認。

gh auth status

ここで「Logged in」と出ていればOKです。

よくある詰まりポイント

1) gh は入ったのにコマンドが見つからない

  • ターミナルを一度閉じて開き直す
  • Windowsなら PowerShell / コマンドプロンプトを管理者で開き直す
  • PATH が通っていない可能性(wingetやbrewなら基本は勝手に通ります)

2) 会社のPCでブラウザ認証ができない

gh auth login の途中で「トークン(PAT)」を使う認証も選べます。
会社のルールで制限がある場合は、管理者の指示に従ってください。


ここまでできれば「gh が必要な手順」はだいたい通る

最低限、次の2つが通れば「gh が必要」と言われる作業は進められます。

  • gh –version
  • gh auth status

あとは、手順書に出てくる gh コマンド(PR作成、Actions確認など)をそのまま実行できる状態です。


まとめ(最短チェック)

  • gh –version が出る(インストールOK)
  • gh auth login でログイン
  • gh auth status で Logged in を確認

必要なら、この次の記事として「よく使うghコマンド最小セット(PR/Issue/Actionsだけ)」も同じテンションで作れます。

コメント

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