该 genomics1 命令行界面（CLI）允许您在终端中舒适地使用大多数 Google 基因组服务功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面

cargo install google-genomics1-cli

在 github 上找到源代码。

用法

此文档是从 genomics API 的 20210324 版本生成的。CLI版本为 5.0.4。

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

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

身份验证

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

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

首次使用作用域时，系统会提示用户进行授权。根据CLI提供的说明进行授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

您可以考虑将标准错误重定向到文件以提高使用便利性，例如genomics1 --debug <资源> <方法> [选项] 2>debug.txt。