5个稳定版本

5.0.4+20210323 2024年3月5日
3.1.0+20210323 2022年4月26日
3.0.0+20210323 2022年3月8日
2.0.4+20210323 2021年4月15日
2.0.0+20210323 2021年4月3日

网络编程 中排名 2636

Download history 53/week @ 2024-03-07 3/week @ 2024-03-14 21/week @ 2024-03-28 12/week @ 2024-04-04

每月下载量 95

MIT 许可证

270KB
3.5K SLoC

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

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

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

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

安装和源代码

使用cargo安装命令行界面:

cargo install google-transcoder1_beta1-cli

github上找到源代码。

用法

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

transcoder1-beta1 [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-beta1 --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目录中,以transcoder1-beta1-为前缀的JSON文件中。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时,用户会被要求授权。根据CLI的指示授予权限或拒绝。

如果作用域被用户认证,相应的信息将作为JSON存储在配置目录中,例如~/.google-service-cli/transcoder1-beta1-token-<scope-hash>.json。不需要手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~20–31MB
~581K SLoC