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

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-keep1-cli

在GitHub上找到源代码。

使用方法

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

keep1 [options]
        media
                download <name> [-p <v>]... [-o <out>]
        notes
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                permissions-batch-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                permissions-batch-delete <parent> (-r <kv>)... [-p <v>]... [-o <out>]
  keep1 --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]

配置

程序将在JSON文件中，文件名以keep1-开头，存储在~/.google-service-cli目录中的所有持久数据。您可以使用--config-dir标志在每次调用时更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，用户将被要求授权。遵循CLI提供的说明进行授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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