跳至主要内容

使用 GitHub Classroom 与 GitHub CLI

您可以使用 gh(GitHub 命令行界面)直接从命令行与 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

如果您尚未这样做,请运行 gh auth login 以验证您的 GitHub 帐户。

要安装 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

gh GitHub Classroom 的子命令

这些部分提供了每个可用操作的示例子命令。在适用情况下,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 标志。