Skip to main content

GitHub Classroom と GitHub CLI の使用

GitHub コマンド ライン インターフェイスである gh を使うと、コマンド ラインから直接 GitHub Classroom を操作できます。

GitHub Classroom CLI について

GitHub CLI は、コンピューターのコマンド ラインから GitHub を使用するためのオープン ソース ツールです。 コマンドラインから作業しているときは、GitHub CLI を使用して時間を節約し、コンテキストの切り替えを回避できます。 詳しくは、「GitHub CLI について」をご覧ください。

GitHub CLI 内の GitHub Classroom を操作すると、次のことができます。

GitHub CLI の設定

GitHub CLI のインストール手順については、GitHub CLI リポジトリを参照してください。

GitHub Classroom 拡張機能と GitHub CLI の使用

まだの場合は、GitHub アカウントで gh auth login を実行して認証を行います。

GitHub Classroom 拡張機能をインストールするには、gh extension install github/gh-classroom を実行します。

gh を使用して GitHub Classroom を操作するには、「gh classroom SUBCOMMAND」と入力します。

GitHub Classroom を操作するために使用できる一連のコマンドの例として、次のことを行うことができます。

  • クラスルームを一覧表示する:
    gh classroom list
  • 特定のクラスルームの課題を一覧表示する:
    gh classroom assignments
  • 特定の課題の情報を表示する:
    gh classroom assignment

GitHub Classroom の gh サブコマンド

これらのセクションでは、使用可能な各操作のサブコマンドの例を示します。 該当する場合は、サブコマンドを実行した後にクラスルームを選択するように求めるメッセージが CLI に表示されます。

コマンド ラインで、gh classroom --help (一般的なヘルプ) または gh classroom SUBCOMMAND --help (特定のサブコマンドのヘルプ) を使用します。

クラスルームを一覧表示する

gh classroom list

所有しているクラスルームのリスト。

クラスルームの情報を表示する

gh classroom view

クラスルーム ID、クラスルームのスラッグ、タイトル、およびクラスルームに関するその他の情報を表示します。

課題を一覧表示する

gh classroom assignments

クラスルームの課題のリストを表示します。

承認済みの課題を一覧表示する

gh classroom accepted-assignments

承認済みの課題のリストと、学生の課題に関する情報を表示します。

課題の情報を表示する

gh classroom assignment

課題の情報を表示します。

課題のスタート コード リポジトリをクローンする

gh classroom clone starter-repo

課題で使用されるスタート コード リポジトリをクローンします。 既定では、スタート コードは現在のディレクトリにクローンされます。 別のディレクトリにクローンするには、--directory フラグを使用します。 ディレクトリが存在しない場合は作成されます。

学生の課題リポジトリをクローンする

gh classroom clone student-repos

特定の課題から学生リポジトリをクローンします。 既定では、学生リポジトリは現在のディレクトリ (課題スラッグに基づく名前のディレクトリ) にクローンされます。 別のディレクトリにクローンするには、--directory フラグを使用します。 ディレクトリが存在しない場合は作成されます。

既定では、すべての学生リポジトリが複製されます。 異なる数のリポジトリを取得するには、--per-page NUMBER フラグを使用します。