GitHub CLI(gh)の入れ方と使い方:ログイン、clone、端末から PR

公式手順で GitHub CLI を入れ、gh auth login を終え、端末から clone するか Pull Request を作る。

端末の GitHub CLI(命令 gh)で clone するか Pull Request を開くには、先に三つ終える。公式の入れ方、gh auth login、それから gh repo clonegh pr create

cli.github.com に従い、包名を当て推量しない。検索語は GitHub CLI インストールgh auth logingh で PR。文書は cli.github.com と cli.github.com/manual/。

gh公式の命令名
authAPI の前にログイン
PR端末から作成

OS に合わせて公式バイナリを入れる

macOS と Windows

macOS:brew install gh。Windows:winget install --id GitHub.cli、または Scoop / Chocolatey。そのあと gh --version

Linux

Debian / Ubuntu / Fedora などは cli.github.com の配布リポジトリに従う。見知らぬ deb を拾わない。Homebrew が禁じられていれば公式リリースの包を使う。

段階命令注意
ログインgh auth logingithub.com か Enterprise、HTTPS か SSH、ブラウザか token
確認gh auth statusアカウント、プロトコル、token の有効
clonegh repo clone owner/repo非公開は権限、SSO 組織は追加承認
PRgh pr create枝は push 済み。--fill か手書き

導入、ログイン、clone か PR

  1. 01
    入れて版を確認する

    公式ページのパッケージマネージャを選ぶ。gh --version が版を出す。命令がなければ PATH。古い第三者の gh と混ぜない。

  2. 02
    gh auth login を走らせる

    GitHub.com(または管理者の Enterprise)。日常は HTTPS。鍵が既にあるなら SSH。ブラウザなら Login with a web browser を選び、一次性コードを github.com/login/device へ。画面なしは PAT。

  3. 03
    一つのリポジトリを clone

    行き先で gh repo clone owner/repo.git が出る。非公開が失敗したら gh auth status と SSO。

  4. 04
    今の枝から PR を作る

    push のあと根で gh pr create。題と本文、または gh pr create --fill。返った URL で diff を見る。

gh --version
gh auth login
gh auth status
gh repo clone owner/repo
cd repo
# 今の枝を commit して push したあと:
gh pr create --title "Fix login timeout" --body "Repro and fix."
ブラウザログインは必須か。
必須ではない。公式ウィザードは personal access token を受け付ける。CI や画面のないホストは token か GH_TOKEN。リポジトリに書かない。
HTTPS と SSH の選び方。
GitHub に載せた SSH 鍵があるなら SSH。なければ HTTPS を選び、gh に資格情報ヘルパーを任せる。
pr create がリポジトリを見つけない、または拒否する。
今の場所が git リポジトリか、remote が GitHub か、枝が push 済みか、書き込み権があるかを見る。SSO 組織は承認ページで org を有効にする。
入れれば図の共有の代わりになるか。
ならない。端末の GitHub クライアントである。会議が同じ図なら sitdraw を開く。

リポジトリを触る前にログインする

gh auth status が通るまで、失敗した clone を網の障害だと決めない。多くはアカウント、SSO、プロトコルの食い違い。

描き始める