22个稳定版本 (4个主要版本)

5.0.4+20181005 2024年3月5日
3.1.0+20181005 2022年4月26日
3.0.0+20181005 2022年3月8日
2.0.4+20181005 2021年4月15日
0.3.6+20160802 2016年9月11日

#2837 in 网络编程

Download history 6/week @ 2024-07-02

每月461次 下载

MIT 许可证

555KB
7K SLoC

appengine1-beta4 命令行界面(CLI)允许您在终端中舒适地使用大多数Google appengine服务的功能。

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

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

有关appengine API的所有其他信息,请参阅官方文档网站

安装和源代码

使用cargo安装命令行界面:

cargo install google-appengine1_beta4-cli

GitHub上找到源代码

用法

本文档是根据版本20181005的appengine API生成的。CLI版本为5.0.4

appengine1-beta4 [options]
        apps
                create (-r <kv>)... [-p <v>]... [-o <out>]
                get <apps-id> [-p <v>]... [-o <out>]
                locations-get <apps-id> <locations-id> [-p <v>]... [-o <out>]
                locations-list <apps-id> [-p <v>]... [-o <out>]
                modules-delete <apps-id> <modules-id> [-p <v>]... [-o <out>]
                modules-get <apps-id> <modules-id> [-p <v>]... [-o <out>]
                modules-list <apps-id> [-p <v>]... [-o <out>]
                modules-patch <apps-id> <modules-id> (-r <kv>)... [-p <v>]... [-o <out>]
                modules-versions-create <apps-id> <modules-id> (-r <kv>)... [-p <v>]... [-o <out>]
                modules-versions-delete <apps-id> <modules-id> <versions-id> [-p <v>]... [-o <out>]
                modules-versions-get <apps-id> <modules-id> <versions-id> [-p <v>]... [-o <out>]
                modules-versions-instances-debug <apps-id> <modules-id> <versions-id> <instances-id> (-r <kv>)... [-p <v>]... [-o <out>]
                modules-versions-instances-delete <apps-id> <modules-id> <versions-id> <instances-id> [-p <v>]... [-o <out>]
                modules-versions-instances-get <apps-id> <modules-id> <versions-id> <instances-id> [-p <v>]... [-o <out>]
                modules-versions-instances-list <apps-id> <modules-id> <versions-id> [-p <v>]... [-o <out>]
                modules-versions-list <apps-id> <modules-id> [-p <v>]... [-o <out>]
                modules-versions-patch <apps-id> <modules-id> <versions-id> (-r <kv>)... [-p <v>]... [-o <out>]
                operations-get <apps-id> <operations-id> [-p <v>]... [-o <out>]
                operations-list <apps-id> [-p <v>]... [-o <out>]
                patch <apps-id> (-r <kv>)... [-p <v>]... [-o <out>]
  appengine1-beta4 --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文件中,文件名以appengine1-beta4-开头。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时,用户会被要求授权。按照CLI的指示授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

--debug标志会将错误使用Debug表示法打印到标准错误。

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

依赖项

~20–31MB
~579K SLoC