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

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

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-sourcerepo1-cli

在GitHub上找到源代码。

用法

本文档是根据修订版20240304的Cloud Source Repositories API生成的。CLI版本为5.0.4。

sourcerepo1 [options]
        projects
                get-config <name> [-p <v>]... [-o <out>]
                repos-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                repos-delete <name> [-p <v>]... [-o <out>]
                repos-get <name> [-p <v>]... [-o <out>]
                repos-get-iam-policy <resource> [-p <v>]... [-o <out>]
                repos-list <name> [-p <v>]... [-o <out>]
                repos-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                repos-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                repos-sync <name> (-r <kv>)... [-p <v>]... [-o <out>]
                repos-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                update-config <name> (-r <kv>)... [-p <v>]... [-o <out>]
  sourcerepo1 --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文件中，文件前缀为sourcerepo1-。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，用户会被要求授权。按照CLI提供的说明授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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