GitHub CLI チートシート

使用例

gh auth login

解説

GitHub CLIを使用するための認証を行います。ブラウザ経由またはトークンを使用してログインし、PCに認証情報を保存します。最初に必ず実行するコマンドです。

使用例

gh config set editor vim

解説

GitHub CLIのデフォルトエディタやプロトコル（ssh/https）などを設定します。自分好みの環境を構築するために使用します。

使用例

gh repo create my-project --public --clone

解説

GitHub上に新しいリポジトリを作成します。ローカルディレクトリから作成することも、空のリポジトリを作ってすぐにクローンすることも可能です。

使用例

gh repo clone owner/repo

解説

GitHub上のリポジトリをローカルにクローンします。`git clone` と似ていますが、URLをコピーする必要がなく、`owner/repo` の形式だけで指定できるため手軽です。

使用例

gh repo view --web

解説

現在のリポジトリのGitHubページをブラウザで開きます。わざわざブラウザで検索したりURLを打つ手間が省ける、地味ながら強力な時短コマンドです。

使用例

gh browse src/main.ts

解説

指定したファイルやディレクトリをGitHubのWeb画面で開きます。行番号を指定してその行をハイライトした状態で開くことも可能です。

使用例

gh pr create --web

解説

現在のブランチからGitHub上でPull Requestを作成します。`--web`オプションを使用すると、ブラウザが開き、Web UI上で詳細入力を行えるため非常にスムーズです。

使用例

gh pr list --state open

解説

リポジトリ内のPull Request一覧を表示します。自分の担当分だけをフィルタリングしたり、現在のステータスをターミナル上で素早く確認できます。

使用例

gh pr checkout 123

解説

指定したPR番号のブランチをローカルにチェックアウトします。レビュー時に手元で動作確認をしたい場合、ブランチ名を探す必要がなく、番号だけで移動できるため便利です。

使用例

gh issue create --title "Bug fix" --body "Details..."

解説

コマンドラインから直接Issueを作成します。インタラクティブモードを使用すれば、タイトルや説明文、ラベルなどを対話形式で入力していくことができます。

使用例

gh issue list --assignee "@me"

解説

リポジトリのIssue一覧を表示します。自分にアサインされたタスクだけを抽出して表示するなど、タスク管理ツールとしても活用できます。

使用例

gh release create v1.0.0 --generate-notes

解説

GitHub Releasesを作成します。`--generate-notes` を付けると、前回のリリースからの差分（PRタイトルなど）から自動的にリリースノートを生成してくれます。

使用例

gh run list

解説

GitHub Actionsの実行履歴（ワークフローラン）の一覧を表示します。CI/CDパイプラインが成功したか失敗したかを、ターミナルから離れずに確認できます。

使用例

gh run watch

解説

現在実行中のGitHub Actionsの完了を待機し、リアルタイムでステータスを表示します。デプロイ完了までプログレスバーを見ながら待つことができます。

使用例

gh secret set MY_API_KEY

解説

リポジトリのSecrets（機密情報）を設定します。標準入力から値を渡せるため、履歴に残らず安全にAPIキーなどを登録できます。

使用例

gh gist create myscript.py

解説

コードスニペットなどをGitHub Gistにアップロードして共有します。ちょっとしたメモやコード片をオンラインで保存・共有したい時に便利です。

使用例

gh alias set co 'pr checkout'

解説

よく使う長いコマンドに短い別名を付けます。例えば `gh co 123` でPRをチェックアウトできるようにするなど、CLIを自分好みに拡張できます。