transcoder1 命令行界面 (CLI) 允许您从终端舒适地使用 Google Transcoder 服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以通过标志将其重定向到文件，而不管您的 shell 功能如何。错误将打印到标准错误，并导致程序的退出代码为非零。

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

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

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-transcoder1-cli

在 GitHub 上找到源代码。

用法

此文档是从修订版 20240221 的 Transcoder API 生成的。CLI 的版本是 5.0.4。

transcoder1 [options]
        projects
                locations-job-templates-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-job-templates-delete <name> [-p <v>]... [-o <out>]
                locations-job-templates-get <name> [-p <v>]... [-o <out>]
                locations-job-templates-list <parent> [-p <v>]... [-o <out>]
                locations-jobs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-jobs-delete <name> [-p <v>]... [-o <out>]
                locations-jobs-get <name> [-p <v>]... [-o <out>]
                locations-jobs-list <parent> [-p <v>]... [-o <out>]
  transcoder1 --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 文件中，文件以 transcoder1- 前缀。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

有关各种类型持久数据的更多信息，请参阅以下段落。

身份验证

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

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

第一次使用范围时，系统会要求用户授权。按照CLI的指示授予或拒绝权限。

如果用户已对某个范围进行身份验证，相应的信息将被存储在配置目录中，例如 ~/.google-service-cli/transcoder1-token-<scope-hash>.json，以JSON格式。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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