使用 proximitybeacon1-beta1 命令行界面 (CLI)，您可以从终端舒适地使用 Google proximitybeacon 服务的几乎所有功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-proximitybeacon1_beta1-cli

在 GitHub 上找到源代码。

用法

本文档是从 proximitybeacon API 的 20200127 版本生成的。CLI 的版本是 5.0.4。

proximitybeacon1-beta1 [options]
        beaconinfo
                getforobserved (-r <kv>)... [-p <v>]... [-o <out>]
        beacons
                activate <beacon-name> [-p <v>]... [-o <out>]
                attachments-batch-delete <beacon-name> [-p <v>]... [-o <out>]
                attachments-create <beacon-name> (-r <kv>)... [-p <v>]... [-o <out>]
                attachments-delete <attachment-name> [-p <v>]... [-o <out>]
                attachments-list <beacon-name> [-p <v>]... [-o <out>]
                deactivate <beacon-name> [-p <v>]... [-o <out>]
                decommission <beacon-name> [-p <v>]... [-o <out>]
                delete <beacon-name> [-p <v>]... [-o <out>]
                diagnostics-list <beacon-name> [-p <v>]... [-o <out>]
                get <beacon-name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                register (-r <kv>)... [-p <v>]... [-o <out>]
                update <beacon-name> (-r <kv>)... [-p <v>]... [-o <out>]
        methods
                get-eidparams [-p <v>]... [-o <out>]
        namespaces
                list [-p <v>]... [-o <out>]
                update <namespace-name> (-r <kv>)... [-p <v>]... [-o <out>]
  proximitybeacon1-beta1 --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 文件中，文件名以 proximitybeacon1-beta1- 为前缀。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

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

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

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

应用程序密钥

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

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

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

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

调试

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

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

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