12个稳定版本 (3个主要版本)

5.0.4+20240202 2024年3月5日
3.1.0+20220211 2022年4月26日
3.0.0+20220211 2022年3月8日
2.0.4+20210309 2021年4月15日
1.0.8+20181008 2018年10月14日

#3 in #jobs

MIT 许可证

500KB
6K SLoC

使用 jobs3 命令行界面(CLI)可以从终端舒适地使用大多数 Google Cloud Talent Solution 服务功能。

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

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

有关 Cloud Talent Solution API 的其他信息,请参阅官方文档网站

安装和源代码

使用 cargo 安装命令行界面:

cargo install google-jobs3-cli

GitHub 上找到源代码。

用法

此文档是从修订版 20240202Cloud Talent Solution API 生成的。CLI 版本为 5.0.4

jobs3 [options]
        projects
                client-events-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                companies-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                companies-delete <name> [-p <v>]... [-o <out>]
                companies-get <name> [-p <v>]... [-o <out>]
                companies-list <parent> [-p <v>]... [-o <out>]
                companies-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                complete <name> [-p <v>]... [-o <out>]
                jobs-batch-delete <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                jobs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                jobs-delete <name> [-p <v>]... [-o <out>]
                jobs-get <name> [-p <v>]... [-o <out>]
                jobs-list <parent> [-p <v>]... [-o <out>]
                jobs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                jobs-search <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                jobs-search-for-alert <parent> (-r <kv>)... [-p <v>]... [-o <out>]
  jobs3 --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 文件中,文件名以 jobs3- 开头。您可以使用 --config-dir 标志在每个调用上更改用于存储配置的目录。

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

身份验证

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

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

当第一次使用作用域时,会询问用户权限。根据CLI的说明授予权限或拒绝。

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

要撤销授予的认证,请参阅官方文档

应用程序密钥

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

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

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

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

调试

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

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

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

依赖关系

~20–31MB
~577K SLoC