classroom1 命令行界面（CLI）允许您在终端舒适地使用大多数 Google 课堂服务的功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其重定向到与您的 shell 功能无关的文件。错误将打印到标准错误，并导致程序退出代码不为零。

如果请求数据结构，则这些数据结构将以漂亮的 JSON 格式返回，以便作为其他工具的输入。

有关课堂 API 的其他一切信息，请参阅官方文档网站。

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-classroom1-cli

在 github 上找到源代码。

用法

本文档是从修订版 20240227 的 classroom API 生成的。CLI 版本为 5.0.4。

classroom1 [options]
        courses
                aliases-create <course-id> (-r <kv>)... [-p <v>]... [-o <out>]
                aliases-delete <course-id> <alias> [-p <v>]... [-o <out>]
                aliases-list <course-id> [-p <v>]... [-o <out>]
                announcements-create <course-id> (-r <kv>)... [-p <v>]... [-o <out>]
                announcements-delete <course-id> <id> [-p <v>]... [-o <out>]
                announcements-get <course-id> <id> [-p <v>]... [-o <out>]
                announcements-list <course-id> [-p <v>]... [-o <out>]
                announcements-modify-assignees <course-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                announcements-patch <course-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                course-work-create <course-id> (-r <kv>)... [-p <v>]... [-o <out>]
                course-work-delete <course-id> <id> [-p <v>]... [-o <out>]
                course-work-get <course-id> <id> [-p <v>]... [-o <out>]
                course-work-list <course-id> [-p <v>]... [-o <out>]
                course-work-modify-assignees <course-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                course-work-patch <course-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                course-work-student-submissions-get <course-id> <course-work-id> <id> [-p <v>]... [-o <out>]
                course-work-student-submissions-list <course-id> <course-work-id> [-p <v>]... [-o <out>]
                course-work-student-submissions-modify-attachments <course-id> <course-work-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                course-work-student-submissions-patch <course-id> <course-work-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                course-work-student-submissions-reclaim <course-id> <course-work-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                course-work-student-submissions-return <course-id> <course-work-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                course-work-student-submissions-turn-in <course-id> <course-work-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                course-work-materials-create <course-id> (-r <kv>)... [-p <v>]... [-o <out>]
                course-work-materials-delete <course-id> <id> [-p <v>]... [-o <out>]
                course-work-materials-get <course-id> <id> [-p <v>]... [-o <out>]
                course-work-materials-list <course-id> [-p <v>]... [-o <out>]
                course-work-materials-patch <course-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <id> [-p <v>]... [-o <out>]
                get <id> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                patch <id> (-r <kv>)... [-p <v>]... [-o <out>]
                students-create <course-id> (-r <kv>)... [-p <v>]... [-o <out>]
                students-delete <course-id> <user-id> [-p <v>]... [-o <out>]
                students-get <course-id> <user-id> [-p <v>]... [-o <out>]
                students-list <course-id> [-p <v>]... [-o <out>]
                teachers-create <course-id> (-r <kv>)... [-p <v>]... [-o <out>]
                teachers-delete <course-id> <user-id> [-p <v>]... [-o <out>]
                teachers-get <course-id> <user-id> [-p <v>]... [-o <out>]
                teachers-list <course-id> [-p <v>]... [-o <out>]
                topics-create <course-id> (-r <kv>)... [-p <v>]... [-o <out>]
                topics-delete <course-id> <id> [-p <v>]... [-o <out>]
                topics-get <course-id> <id> [-p <v>]... [-o <out>]
                topics-list <course-id> [-p <v>]... [-o <out>]
                topics-patch <course-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <id> (-r <kv>)... [-p <v>]... [-o <out>]
        invitations
                accept <id> [-p <v>]... [-o <out>]
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <id> [-p <v>]... [-o <out>]
                get <id> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
        registrations
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <registration-id> [-p <v>]... [-o <out>]
        user-profiles
                get <user-id> [-p <v>]... [-o <out>]
                guardian-invitations-create <student-id> (-r <kv>)... [-p <v>]... [-o <out>]
                guardian-invitations-get <student-id> <invitation-id> [-p <v>]... [-o <out>]
                guardian-invitations-list <student-id> [-p <v>]... [-o <out>]
                guardian-invitations-patch <student-id> <invitation-id> (-r <kv>)... [-p <v>]... [-o <out>]
                guardians-delete <student-id> <guardian-id> [-p <v>]... [-o <out>]
                guardians-get <student-id> <guardian-id> [-p <v>]... [-o <out>]
                guardians-list <student-id> [-p <v>]... [-o <out>]
  classroom1 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将在 ~/.google-service-cli 目录中的 JSON 文件中存储所有持久数据，文件以 classroom1- 开头。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

以下段落提供了有关各种类型持久数据的更多信息。

身份验证

大多数 API 需要用户对任何请求进行身份验证。如果是这样，则 作用域 确定了授予的权限集。这些的粒度通常不超过 只读 或 完全访问。

如果未设置，系统将自动选择最小的可行范围，例如在调用只读方法时，它只会请求只读范围。您可以使用--scope标志直接指定范围。所有适用的范围都在各自方法的CLI文档中有记录。

首次使用范围时，会提示用户授权。根据CLI的指示授权或拒绝。

如果用户验证了范围，相关信息将被存储在配置目录中，格式为JSON，例如~/.google-service-cli/classroom1-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授予的认证，请参阅官方文档。

应用程序密钥

为了允许任何应用程序使用Google服务，它需要通过Google开发者控制台进行注册。应用程序可能使用的API将逐一启用。大多数API可以免费使用，并有每日配额。

为了在不强制用户注册自己的应用程序的情况下更方便地使用CLI，CLI自带一个默认应用程序密钥，相应地进行了配置。这也意味着全球范围内的重用可能会耗尽每日配额。

您可以通过在此位置放置自己的密钥文件来解决这个问题：~/.google-service-cli/classroom1-secret.json，假设已为它启用了所需的classroom API。这样的密钥文件可以从Google开发者控制台的APIs & auth -> Credentials -> Download JSON下载并直接使用。

有关如何设置Google项目和启用API的更多信息，请参阅官方文档。

调试

尽管CLI尽力提供可用的错误消息，但有时可能希望了解导致特定问题的确切原因。这是通过允许将所有客户端-服务器通信直接输出到标准错误来完成的。

使用--debug标志将错误以Debug表示法打印到标准错误。

您可以考虑将标准错误重定向到文件以方便使用，例如classroom1 --debug <resource> <method> [options] 2>debug.txt。