OS | macOS 13.5.1 |
---|---|
GitHub CLI | 2.33.0 |
Git | 2.42.0 |
gh
を使うコマンドです。gh
はコマンドライン上のGitHubです。PullRequestやIssue、その他のGitHubの機能を、git
やコードを操作しているターミナルで利用可能にします。gh
コマンド)はターミナルやコードから使えるコマンドラインインターフェイスです。$ brew install gh
$ sudo port install gh
$ conda install gh --channel conda-forge
$ spack install gh
apt
パッケージ管理が可能なOSのインストール例です。$ type -p curl >/dev/null || (sudo apt update && sudo apt install curl -y)
$ curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg \
&& sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg \
&& echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
&& sudo apt update \
&& sudo apt install gh -y
$ winget install --id GitHub.cli
$ scoop install gh
$ choco install gh
$ conda install gh --channel conda-forge
$ gh auth login
emacs
を選んだ例)$ gh config set editor emacs
gh browse
gh browse
を実行すると、該当のリポジトリをWebブラウザで開けます。$ gh browse
gh
コマンドは共通で、Gitリポジトリのないディレクトリでこのコマンドを実行すると、以下のようなエラーが出ます。$ gh browse
unable to determine base repository: failed to run git: fatal: not a git repository (or any of the parent directories): .git
gh pr list
gh pr list
も、コードレビューを頻繁に行うエンジニアであれば便利です。$ gh pr list
gh pr checks
gh pr checks
が便利です。--watch
オプションをつけると完了まで監視できます。$ gh pr checks [pr listの番号 or PRのURL or ブランチ名] --watch
gh
コマンドに慣れてきたら覚えておくと便利なコマンド集です。gh pr create
gh pr create
は、オプションを使いこなすと便利なコマンドです。(オプションなしだと結局ブラウザ作業ですることが増えます)$ gh pr create -a @me -d -l ラベル名 -t 'Bug fix' -w
@me
で自分)git checkout
を効率化するgh pr checkout
checkout
して動作確認をする際に、pull
してcheckout
の手間を削減するgh pr checkout
です。gh co
コマンドでも実行可能です。$ gh alias list
co: pr checkout
gh pr list
の番号、PullRequestのURL、ブランチ名指定でcheckout
できます。$ gh pr list
Showing 3 of 3 open pull requests in my/repo
#56 Bug Fix in /api hoge about 2 days ago
#54 New Function in /app huga about 3 days ago
#53 Write Doc in / ponyo about 4 days ago
$ gh co 54
gh run watch
gh pr checks
といくらかかぶりますが、こちらはGitHub Actionsのワークフローを監視するgh run watch
コマンドです。terminal-notifier
を使って完了をポップアップ通知する方法を記載します。$ gh run list # これで実行タスクのIDを入手
$ gh run watch && terminal-notifier -message "GitHub Actions完了"
gh
コマンドがありますが、一旦上記を覚えるだけでもかなり手間が削減できます。