该 fitness1 命令行界面 (CLI) 允许您从终端舒适地使用 Google 健身服务的几乎所有功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面

cargo install google-fitness1-cli

在 GitHub 上查找源代码。

用法

此文档是从修订版 20240304 的 fitness API 生成的。CLI 的版本是 5.0.4。

fitness1 [options]
        users
                data-sources-create <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
                data-sources-data-point-changes-list <user-id> <data-source-id> [-p <v>]... [-o <out>]
                data-sources-datasets-delete <user-id> <data-source-id> <dataset-id> [-p <v>]...
                data-sources-datasets-get <user-id> <data-source-id> <dataset-id> [-p <v>]... [-o <out>]
                data-sources-datasets-patch <user-id> <data-source-id> <dataset-id> (-r <kv>)... [-p <v>]... [-o <out>]
                data-sources-delete <user-id> <data-source-id> [-p <v>]... [-o <out>]
                data-sources-get <user-id> <data-source-id> [-p <v>]... [-o <out>]
                data-sources-list <user-id> [-p <v>]... [-o <out>]
                data-sources-update <user-id> <data-source-id> (-r <kv>)... [-p <v>]... [-o <out>]
                dataset-aggregate <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
                sessions-delete <user-id> <session-id> [-p <v>]...
                sessions-list <user-id> [-p <v>]... [-o <out>]
                sessions-update <user-id> <session-id> (-r <kv>)... [-p <v>]... [-o <out>]
  fitness1 --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 目录中存储所有持久数据，该目录以 fitness1- 前缀的 JSON 文件。您可以使用 --config-dir 标志按调用方式更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，会请求用户授权。按照CLI的指示授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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