books1 命令行界面（CLI）允许用户在终端中方便地使用Google书籍服务的大部分功能。

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

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-books1-cli

在github上找到源代码。

用法

此文档是根据修订版20240222的books API生成的。CLI版本为5.0.4。

books1 [options]
        bookshelves
                get <user-id> <shelf> [-p <v>]... [-o <out>]
                list <user-id> [-p <v>]... [-o <out>]
                volumes-list <user-id> <shelf> [-p <v>]... [-o <out>]
        cloudloading
                add-book [-p <v>]... [-o <out>]
                delete-book <volume-id> [-p <v>]... [-o <out>]
                update-book (-r <kv>)... [-p <v>]... [-o <out>]
        dictionary
                list-offline-metadata <cpksver> [-p <v>]... [-o <out>]
        familysharing
                get-family-info [-p <v>]... [-o <out>]
                share [-p <v>]... [-o <out>]
                unshare [-p <v>]... [-o <out>]
        layers
                annotation-data-get <volume-id> <layer-id> <annotation-data-id> <content-version> [-p <v>]... [-o <out>]
                annotation-data-list <volume-id> <layer-id> <content-version> [-p <v>]... [-o <out>]
                get <volume-id> <summary-id> [-p <v>]... [-o <out>]
                list <volume-id> [-p <v>]... [-o <out>]
                volume-annotations-get <volume-id> <layer-id> <annotation-id> [-p <v>]... [-o <out>]
                volume-annotations-list <volume-id> <layer-id> <content-version> [-p <v>]... [-o <out>]
        myconfig
                get-user-settings [-p <v>]... [-o <out>]
                release-download-access <cpksver> <volume-ids>... [-p <v>]... [-o <out>]
                request-access <cpksver> <nonce> <source> <volume-id> [-p <v>]... [-o <out>]
                sync-volume-licenses <cpksver> <nonce> <source> [-p <v>]... [-o <out>]
                update-user-settings (-r <kv>)... [-p <v>]... [-o <out>]
        mylibrary
                annotations-delete <annotation-id> [-p <v>]... [-o <out>]
                annotations-insert (-r <kv>)... [-p <v>]... [-o <out>]
                annotations-list [-p <v>]... [-o <out>]
                annotations-summary <layer-ids>... <volume-id> [-p <v>]... [-o <out>]
                annotations-update <annotation-id> (-r <kv>)... [-p <v>]... [-o <out>]
                bookshelves-add-volume <shelf> <volume-id> [-p <v>]... [-o <out>]
                bookshelves-clear-volumes <shelf> [-p <v>]... [-o <out>]
                bookshelves-get <shelf> [-p <v>]... [-o <out>]
                bookshelves-list [-p <v>]... [-o <out>]
                bookshelves-move-volume <shelf> <volume-id> <volume-position> [-p <v>]... [-o <out>]
                bookshelves-remove-volume <shelf> <volume-id> [-p <v>]... [-o <out>]
                bookshelves-volumes-list <shelf> [-p <v>]... [-o <out>]
                readingpositions-get <volume-id> [-p <v>]... [-o <out>]
                readingpositions-set-position <volume-id> <position> <timestamp> [-p <v>]... [-o <out>]
        notification
                get <notification-id> [-p <v>]... [-o <out>]
        onboarding
                list-categories [-p <v>]... [-o <out>]
                list-category-volumes [-p <v>]... [-o <out>]
        personalizedstream
                get [-p <v>]... [-o <out>]
        promooffer
                accept [-p <v>]... [-o <out>]
                dismiss [-p <v>]... [-o <out>]
                get [-p <v>]... [-o <out>]
        series
                get <series-id>... [-p <v>]... [-o <out>]
                membership-get <series-id> [-p <v>]... [-o <out>]
        volumes
                associated-list <volume-id> [-p <v>]... [-o <out>]
                get <volume-id> [-p <v>]... [-o <out>]
                list <q> [-p <v>]... [-o <out>]
                mybooks-list [-p <v>]... [-o <out>]
                recommended-list [-p <v>]... [-o <out>]
                recommended-rate <rating> <volume-id> [-p <v>]... [-o <out>]
                useruploaded-list [-p <v>]... [-o <out>]
  books1 --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目录中存储所有持久数据，该目录以books1-为前缀的JSON文件。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，会要求用户进行授权。根据CLI的指示授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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