youtube3 命令行界面（CLI）允许您从终端舒适地使用Google YouTube服务的多数功能。

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

如果请求数据结构，这些将以美观打印的JSON格式返回，作为其他工具的输入。

有关YouTube API的其余信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行界面

cargo install google-youtube3-cli

在GitHub上查找源代码。

用法

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

youtube3 [options]
        abuse-reports
                insert (-r <kv>)... [-p <v>]... [-o <out>]
        activities
                list <part>... [-p <v>]... [-o <out>]
        captions
                delete <id> [-p <v>]...
                download <id> [-p <v>]... [-o <out>]
                insert (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                list <part>... <video-id> [-p <v>]... [-o <out>]
                update (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
        channel-banners
                insert (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
        channel-sections
                delete <id> [-p <v>]...
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                list <part>... [-p <v>]... [-o <out>]
                update (-r <kv>)... [-p <v>]... [-o <out>]
        channels
                list <part>... [-p <v>]... [-o <out>]
                update (-r <kv>)... [-p <v>]... [-o <out>]
        comment-threads
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                list <part>... [-p <v>]... [-o <out>]
        comments
                delete <id> [-p <v>]...
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                list <part>... [-p <v>]... [-o <out>]
                mark-as-spam <id>... [-p <v>]...
                set-moderation-status <id>... <moderation-status> [-p <v>]...
                update (-r <kv>)... [-p <v>]... [-o <out>]
        i18n-languages
                list <part>... [-p <v>]... [-o <out>]
        i18n-regions
                list <part>... [-p <v>]... [-o <out>]
        live-broadcasts
                bind <id> <part>... [-p <v>]... [-o <out>]
                delete <id> [-p <v>]...
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                insert-cuepoint (-r <kv>)... [-p <v>]... [-o <out>]
                list <part>... [-p <v>]... [-o <out>]
                transition <broadcast-status> <id> <part>... [-p <v>]... [-o <out>]
                update (-r <kv>)... [-p <v>]... [-o <out>]
        live-chat-bans
                delete <id> [-p <v>]...
                insert (-r <kv>)... [-p <v>]... [-o <out>]
        live-chat-messages
                delete <id> [-p <v>]...
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                list <live-chat-id> <part>... [-p <v>]... [-o <out>]
        live-chat-moderators
                delete <id> [-p <v>]...
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                list <live-chat-id> <part>... [-p <v>]... [-o <out>]
        live-streams
                delete <id> [-p <v>]...
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                list <part>... [-p <v>]... [-o <out>]
                update (-r <kv>)... [-p <v>]... [-o <out>]
        members
                list <part>... [-p <v>]... [-o <out>]
        memberships-levels
                list <part>... [-p <v>]... [-o <out>]
        playlist-images
                delete [-p <v>]...
                insert (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                update (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
        playlist-items
                delete <id> [-p <v>]...
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                list <part>... [-p <v>]... [-o <out>]
                update (-r <kv>)... [-p <v>]... [-o <out>]
        playlists
                delete <id> [-p <v>]...
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                list <part>... [-p <v>]... [-o <out>]
                update (-r <kv>)... [-p <v>]... [-o <out>]
        search
                list <part>... [-p <v>]... [-o <out>]
        subscriptions
                delete <id> [-p <v>]...
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                list <part>... [-p <v>]... [-o <out>]
        super-chat-events
                list <part>... [-p <v>]... [-o <out>]
        tests
                insert (-r <kv>)... [-p <v>]... [-o <out>]
        third-party-links
                delete <linking-token> <type> [-p <v>]...
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                list <part>... [-p <v>]... [-o <out>]
                update (-r <kv>)... [-p <v>]... [-o <out>]
        thumbnails
                set <video-id> (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
        video-abuse-report-reasons
                list <part>... [-p <v>]... [-o <out>]
        video-categories
                list <part>... [-p <v>]... [-o <out>]
        videos
                delete <id> [-p <v>]...
                get-rating <id>... [-p <v>]... [-o <out>]
                insert (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                list <part>... [-p <v>]... [-o <out>]
                rate <id> <rating> [-p <v>]...
                report-abuse (-r <kv>)... [-p <v>]...
                update (-r <kv>)... [-p <v>]... [-o <out>]
        watermarks
                set <channel-id> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]...
                unset <channel-id> [-p <v>]...
        youtube
                v3-update-comment-threads (-r <kv>)... [-p <v>]... [-o <out>]
  youtube3 --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 文件中，文件名以 youtube3 开头。您可以使用 --config-dir 标志根据调用更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时，用户会被要求授权。遵循CLI提供的指示授权权限，或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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