こんにちは。今回は、GitHubについて初心者エンジニアに向けて、GitHub CLIのリファレンスについて解説します。
はじめに
GitHub CLIは、GitHubをコマンドラインから操作することができるツールです。GUIに慣れている人でも、ターミナル上で作業することで、より簡単かつスピーディーにGitHubの操作ができます。本記事では、GitHub CLIの基本的なコマンドを紹介し、初歩的な使い方を学びましょう。
インストール方法
GitHub CLIをインストールするには、以下のコマンドを実行します。
$ brew install gh
または、GitHub CLIの公式サイトからインストーラーをダウンロードしてインストールすることもできます。
基本的なコマンド
リポジトリの作成
GitHubにリポジトリを作成するには、以下のコマンドを実行します。
$ gh repo create
このコマンドを実行すると、タイトルやプライバシーの設定をすることができます。
コミットの作成とプッシュ
リポジトリに変更を加えた場合、以下のコマンドでコミットを作成します。
$ gh commit
そして、以下のコマンドで変更をプッシュします。
$ gh push
プルリクエストの作成
リポジトリをコラボレーションする場合、プルリクエストを作成して変更をマージする必要があります。以下のコマンドでプルリクエストを作成できます。
$ gh pr create
イシューの作成
バグ修正や新機能の開発など、プロジェクトに問題が発生した場合、イシューを作成して解決する必要があります。
$ gh issue create
その他のコマンド
GitHub CLIには、さまざまなコマンドがあります。それらを習得することで、より高度な操作ができるようになります。
$ gh help
サンプルコード
以下は、リポジトリのクローン、ブランチの作成、変更のプル、マージなど、GitHub CLIでよく使うコマンドのサンプルコードです。
# リポジトリのクローン
$ gh repo clone USERNAME/REPO
# ブランチの作成
$ gh repo checkout -b NEW_BRANCH
# 変更のプル
$ gh pull origin MAIN_BRANCH
# マージの実行
$ gh pr merge URL
注意点
GitHub CLIを使用するには、GitHubのアカウントが必要です。また、GitHub CLI自体は英語なので、英語のドキュメントを読むことが必要な場合があります。
コマンドライン操作に慣れていない人や、初心者には扱いづらい場合があります。操作に不慣れな場合は、まずはGUIで操作を覚え、徐々にCLIに取り入れることをお勧めします。
まとめ
GitHub CLIは、コマンドライン上でGitHubの操作を行うことができる優れたツールです。この記事では、GitHub CLIの基本的なコマンドを紹介し、初心者でも使いやすくなるように解説しました。ぜひ、実際に試してみてください。
参考記事:
Github 関連のまとめ
オンラインスクールを講師として活用する!