docs1 命令行界面（CLI）允许您从终端舒适地使用 Google Docs 服务的多数功能。

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

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

有关 Docs API 的其他信息，请参阅 官方文档网站。

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-docs1-cli

在 GitHub 上找到源代码。

使用方法

此文档是从 Docs API 的 20240229 修订版生成的。CLI 版本为 5.0.4。

docs1 [options]
        documents
                batch-update <document-id> (-r <kv>)... [-p <v>]... [-o <out>]
                create (-r <kv>)... [-p <v>]... [-o <out>]
                get <document-id> [-p <v>]... [-o <out>]
  docs1 --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 目录中，以 docs1- 前缀的 JSON 文件中。您可以使用 --config-dir 标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

当首次使用作用域时，系统会请求用户授权。根据 CLI 的指示进行授权或拒绝。

如果用户已验证作用域，相应信息将以 JSON 格式存储在配置目录中，例如 ~/.google-service-cli/docs1-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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