5个稳定版本

使用旧Rust 2015

1.0.4+20161213 2017年2月4日
1.0.3+20161213 2017年2月1日
1.0.2+20161213 2016年12月27日
1.0.1+20161213 2016年12月24日
1.0.0+20161213 2016年12月16日

#10 in #slide

MIT 许可证

63KB
1.5K SLoC

slides1命令行界面(CLI)允许您在终端中方便地使用Google Slides服务的几乎所有功能。

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

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

有关Slides API的其余信息,请参阅官方文档站点

安装和源代码

使用cargo安装命令行界面:

cargo install google-slides1-cli

GitHub上找到源代码

用法

此文档是根据修订版20161213的Slides API生成的。CLI版本为1.0.4

slides1 [options]
        presentations
                batch-update <presentation-id> (-r <kv>)... [-p <v>]... [-o <out>]
                create (-r <kv>)... [-p <v>]... [-o <out>]
                get <presentation-id> [-p <v>]... [-o <out>]
                pages-get <presentation-id> <page-object-id> [-p <v>]... [-o <out>]
  slides1 --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]
  --debug
            Output all server communication to standard error. `tx` and `rx` are placed
            into the same stream.
  --debug-auth
            Output all communication related to authentication to standard error. `tx`
            and `rx` are placed into the same stream.

配置

程序将所有持久数据存储在~/.google-service-cli目录中,以slides1-为前缀的JSON文件中。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时,用户会被要求授权。按照CLI提供的说明授予权限,或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

带有--debug标志的将打印所有客户端-服务器通信到标准错误,而带有--debug-auth标志的将导致所有与认证相关的通信输出到标准错误。如果设置了--debug标志,则错误结果将被调试打印,可能提供有关问题的更多信息。

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

依赖关系

~17–27MB
~531K SLoC