该workflows1命令行界面（CLI）允许您从终端舒适地使用Google Workflows服务的几乎所有功能。

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

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

有关Workflows API的所有其他信息，请参阅官方文档站点。

安装和源代码

使用cargo安装命令行界面

cargo install google-workflows1-cli

在github上查找源代码。

用法

本文档是根据Workflows API的20240207修订版本生成的。CLI版本为5.0.4。

workflows1 [options]
        projects
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-operations-delete <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
                locations-workflows-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-workflows-delete <name> [-p <v>]... [-o <out>]
                locations-workflows-get <name> [-p <v>]... [-o <out>]
                locations-workflows-list <parent> [-p <v>]... [-o <out>]
                locations-workflows-list-revisions <name> [-p <v>]... [-o <out>]
                locations-workflows-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
  workflows1 --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文件中，文件名以workflows1-开头。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，会提示用户请求权限。按照CLI的指示授予权限或拒绝。

如果用户已认证作用域，相关信息均以JSON格式存储在配置目录中，例如~/.google-service-cli/workflows1-token-.json。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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