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

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

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-sheets4-cli

在GitHub上找到源代码。

用法

本文档是从Sheets API（修订版20240229）生成的。CLI版本为5.0.4。

sheets4 [options]
        spreadsheets
                batch-update <spreadsheet-id> (-r <kv>)... [-p <v>]... [-o <out>]
                create (-r <kv>)... [-p <v>]... [-o <out>]
                developer-metadata-get <spreadsheet-id> <metadata-id> [-p <v>]... [-o <out>]
                developer-metadata-search <spreadsheet-id> (-r <kv>)... [-p <v>]... [-o <out>]
                get <spreadsheet-id> [-p <v>]... [-o <out>]
                get-by-data-filter <spreadsheet-id> (-r <kv>)... [-p <v>]... [-o <out>]
                sheets-copy-to <spreadsheet-id> <sheet-id> (-r <kv>)... [-p <v>]... [-o <out>]
                values-append <spreadsheet-id> <range> (-r <kv>)... [-p <v>]... [-o <out>]
                values-batch-clear <spreadsheet-id> (-r <kv>)... [-p <v>]... [-o <out>]
                values-batch-clear-by-data-filter <spreadsheet-id> (-r <kv>)... [-p <v>]... [-o <out>]
                values-batch-get <spreadsheet-id> [-p <v>]... [-o <out>]
                values-batch-get-by-data-filter <spreadsheet-id> (-r <kv>)... [-p <v>]... [-o <out>]
                values-batch-update <spreadsheet-id> (-r <kv>)... [-p <v>]... [-o <out>]
                values-batch-update-by-data-filter <spreadsheet-id> (-r <kv>)... [-p <v>]... [-o <out>]
                values-clear <spreadsheet-id> <range> (-r <kv>)... [-p <v>]... [-o <out>]
                values-get <spreadsheet-id> <range> [-p <v>]... [-o <out>]
                values-update <spreadsheet-id> <range> (-r <kv>)... [-p <v>]... [-o <out>]
  sheets4 --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文件中，文件名以sheets4-为前缀。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时，系统会要求用户进行授权。按照CLI的说明授权或拒绝授权。

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

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

应用程序密钥

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

为了使CLI更易于使用，而无需强制任何人注册自己的应用程序，CLI自带了一个默认的应用程序密钥，并相应地进行配置。这也意味着全球范围内的重用可能会耗尽每日配额。

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

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

调试

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

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

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