关于 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
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
标志。