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

5.0.4+20240226 2024年3月5日
3.1.0+20220226 2022年4月26日
3.0.0+20220226 2022年3月8日
2.0.4+20210324 2021年4月14日
0.3.6+20160802 2016年9月11日

#1305 in 网络编程

Download history 1/week @ 2024-05-18

每月463次下载

MIT 许可证

1MB
13K SLoC

appengine1命令行界面(CLI)允许您从终端舒适地使用Google appengine服务的大部分功能。

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

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

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

安装和源代码

使用cargo安装命令行界面:

cargo install google-appengine1-cli

GitHub上找到源代码

用法

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

appengine1 [options]
        apps
                authorized-certificates-create <apps-id> (-r <kv>)... [-p <v>]... [-o <out>]
                authorized-certificates-delete <apps-id> <authorized-certificates-id> [-p <v>]... [-o <out>]
                authorized-certificates-get <apps-id> <authorized-certificates-id> [-p <v>]... [-o <out>]
                authorized-certificates-list <apps-id> [-p <v>]... [-o <out>]
                authorized-certificates-patch <apps-id> <authorized-certificates-id> (-r <kv>)... [-p <v>]... [-o <out>]
                authorized-domains-list <apps-id> [-p <v>]... [-o <out>]
                create (-r <kv>)... [-p <v>]... [-o <out>]
                domain-mappings-create <apps-id> (-r <kv>)... [-p <v>]... [-o <out>]
                domain-mappings-delete <apps-id> <domain-mappings-id> [-p <v>]... [-o <out>]
                domain-mappings-get <apps-id> <domain-mappings-id> [-p <v>]... [-o <out>]
                domain-mappings-list <apps-id> [-p <v>]... [-o <out>]
                domain-mappings-patch <apps-id> <domain-mappings-id> (-r <kv>)... [-p <v>]... [-o <out>]
                firewall-ingress-rules-batch-update <apps-id> (-r <kv>)... [-p <v>]... [-o <out>]
                firewall-ingress-rules-create <apps-id> (-r <kv>)... [-p <v>]... [-o <out>]
                firewall-ingress-rules-delete <apps-id> <ingress-rules-id> [-p <v>]... [-o <out>]
                firewall-ingress-rules-get <apps-id> <ingress-rules-id> [-p <v>]... [-o <out>]
                firewall-ingress-rules-list <apps-id> [-p <v>]... [-o <out>]
                firewall-ingress-rules-patch <apps-id> <ingress-rules-id> (-r <kv>)... [-p <v>]... [-o <out>]
                get <apps-id> [-p <v>]... [-o <out>]
                list-runtimes <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>]
                repair <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>]
        projects
                locations-applications-authorized-domains-list <projects-id> <locations-id> <applications-id> [-p <v>]... [-o <out>]
  appengine1 --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-开头。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时,用户会被要求授权。按照CLI的说明授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖关系

~20–32MB
~581K SLoC