検索
ニュース

コマンドラインから「GitHub」を利用できる「GitHub CLI 1.0」が公開リポジトリ操作からマージまで

「GitHub」をターミナルから利用できるツールの正式版「GitHub CLI 1.0」をGitHubが公開した。GitHubにあるワークフローの全てを「gh」コマンドで実行できる。

Share
Tweet
LINE
Hatena

 GitHubは2020年9月18日、「GitHub CLI 1.0」を公開した。

 GitHub CLIは、ソフトウェア開発プロジェクトの共有Webサービス「GitHub」をターミナルからコマンドを入力して利用するツール。GitHub CLIを使えば、コンテキストの切り替え回数が減るため、作業そのものに集中でき、スクリプトの記述や独自ワークフローの作成も簡素化できると、GitHubは述べている。

 GitHubは2020年2月にGitHub CLIのβ版をリリースしていた。今回の1.0版はWindows、macOS、Linux向けだ。

 GitHub CLI 1.0の特徴は次の通り。

  • イシューからリリースまで、GitHub上のワークフローを全てターミナルから実行できる
  • GitHub APIを呼び出してほぼあらゆるアクションのスクリプトを記述でき、任意のコマンドのカスタムエイリアスを設定できる
  • GitHub.comだけでなく、GitHub Enterprise Serverにも接続できる

豊富なコマンドを利用できる

 GitHub CLIは、イシュー作成からリリースまで、GitHubワークフローの全段階で使用できる。GitHub CLIで使える主なコマンドは次の通り。

  • gh repo clone owner/repo
     作業対象リポジトリのクローンを作成する
  • gh issue statusまたはgh issue list --assignee billygriffin
     次にしなければならない作業を探す

次の作業を探しているところ(出典:GitHub)

プルリクエストを実行するには?

  • gh pr create
     機能追加やバグ修正後、GitHub上にプルリクエストを作成する

プルリクエストを実行しているところ(出典:GitHub
  • gh pr checkout 1337
     チームメイトによるプルリクエストのチェックアウトを許可する
  • gh pr diff
     チームメイトによる差分の閲覧を許可する
  • gh pr review
     チームメイトが簡単にレビューを提供できる

レビューを提供したところ(出典:GitHub
  • gh pr checks
     プルリクエストの承認後、このコマンドで、全てのテストに合格していることを確認できる
  • gh pr merge
     ターミナルから直接マージできる。マージした後、ローカルやGitHub.comにあるブランチの削除が提案される

直接マージしたところ(出典:GitHub
  • gh release create [タグ名]
     次のリリース準備が整ったら、このコマンドを使って、コマンドラインから離れることなく、成果物を公開できる

エイリアスとgh apiを使う

 GitHub CLIでは、「gh alias set」コマンドを使って、任意のコマンドのエイリアスを作成できる。強力な「gh api」によってGitHub APIに直接アクセスできるので、「gh」でできることに限界はないと、GitHubは述べている。ユーザーがコマンドを簡単に作成できるという。

GitHub Enterprise Serverへの対応

 GitHub CLI 1.0は、GitHub Enterprise Server 2.20以降でホストされるリポジトリに対応した。これはβ版の発表以降、最も要望が多かった機能だという。

Copyright © ITmedia, Inc. All Rights Reserved.

ページトップに戻る