该 calendar3 命令行界面 (CLI) 允许您在终端中方便地使用 Google 日历服务的几乎所有功能。

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

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

有关日历 API 的其他所有信息，请参阅 官方文档站点。

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-calendar3-cli

在 GitHub 上找到源代码。

用法

本文档是根据修订版 20240223 中的 calendar API 生成的。CLI 的版本为 5.0.4。

calendar3 [options]
        acl
                delete <calendar-id> <rule-id> [-p <v>]...
                get <calendar-id> <rule-id> [-p <v>]... [-o <out>]
                insert <calendar-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <calendar-id> [-p <v>]... [-o <out>]
                patch <calendar-id> <rule-id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <calendar-id> <rule-id> (-r <kv>)... [-p <v>]... [-o <out>]
                watch <calendar-id> (-r <kv>)... [-p <v>]... [-o <out>]
        calendar-list
                delete <calendar-id> [-p <v>]...
                get <calendar-id> [-p <v>]... [-o <out>]
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                patch <calendar-id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <calendar-id> (-r <kv>)... [-p <v>]... [-o <out>]
                watch (-r <kv>)... [-p <v>]... [-o <out>]
        calendars
                clear <calendar-id> [-p <v>]...
                delete <calendar-id> [-p <v>]...
                get <calendar-id> [-p <v>]... [-o <out>]
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                patch <calendar-id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <calendar-id> (-r <kv>)... [-p <v>]... [-o <out>]
        channels
                stop (-r <kv>)... [-p <v>]...
        colors
                get [-p <v>]... [-o <out>]
        events
                delete <calendar-id> <event-id> [-p <v>]...
                get <calendar-id> <event-id> [-p <v>]... [-o <out>]
                import <calendar-id> (-r <kv>)... [-p <v>]... [-o <out>]
                insert <calendar-id> (-r <kv>)... [-p <v>]... [-o <out>]
                instances <calendar-id> <event-id> [-p <v>]... [-o <out>]
                list <calendar-id> [-p <v>]... [-o <out>]
                move <calendar-id> <event-id> <destination> [-p <v>]... [-o <out>]
                patch <calendar-id> <event-id> (-r <kv>)... [-p <v>]... [-o <out>]
                quick-add <calendar-id> <text> [-p <v>]... [-o <out>]
                update <calendar-id> <event-id> (-r <kv>)... [-p <v>]... [-o <out>]
                watch <calendar-id> (-r <kv>)... [-p <v>]... [-o <out>]
        freebusy
                query (-r <kv>)... [-p <v>]... [-o <out>]
        settings
                get <setting> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                watch (-r <kv>)... [-p <v>]... [-o <out>]
  calendar3 --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 文件中，文件以 calendar3- 为前缀。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，将要求用户授权。按照CLI提供的说明授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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