21 个稳定版本 (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月14日
0.3.6+20160802 2016年9月11日

网络编程 中排名第2829

Download history 151/week @ 2024-04-02

每月下载量450

MIT 许可证

555KB
7K SLoC

appengine1-beta5命令行界面(CLI)允许您从终端舒适地使用Google appengine服务的几乎所有功能。

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

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

有关appengine API的更多信息,请参阅官方文档网站

安装和源代码

使用cargo安装命令行界面

cargo install google-appengine1_beta5-cli

github上查找源代码。

用法

本文档是从修订版20181005appengine API生成的。CLI版本为5.0.4

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

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

身份验证

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

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

第一次使用作用域时,会要求用户授权。根据CLI提供的说明进行授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~20–31MB
~582K SLoC