该 urlshortener1 命令行界面（CLI）允许用户从终端舒适地使用Google urlshortener服务的多数功能。

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

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-urlshortener1-cli

在github上找到源代码。

用法

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

urlshortener1 [options]
        url
                get <short-url> [-p <v>]... [-o <out>]
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
  urlshortener1 --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 文件中，文件名以 urlshortener1 为前缀。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

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

如果用户验证了某个范围，相应的信息将作为 JSON 存储在配置目录中，例如 ~/.google-service-cli/urlshortener1-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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