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

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

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

有关QPX Express API的更多信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行界面：

cargo install google-qpxexpress1-cli

在GitHub上找到源代码。

使用说明

此文档是从修订版 20160708 的 QPX Express API生成的。CLI版本为 5.0.4。

qpxexpress1 [options]
        trips
                search (-r <kv>)... [-p <v>]... [-o <out>]
  qpxexpress1 --help

Configuration:
  --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 目录中存储所有持久数据，该目录中的文件以 qpxexpress1- 前缀命名。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，系统会要求用户进行权限。按照CLI提供的说明授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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