saltant CLI

saltant-cli 是基于 saltant 和 saltant-py 开发的一个 CLI 工具。它允许您从终端方便地与 saltant API 进行交互。

安装

使用 pip,

pip install saltant-cli

或者，从源代码开始，在克隆此仓库后运行

python setup.py install

其中 python 版本为 2.7 或 3.5+。

无论您选择哪种方式安装 saltant-cli，请确保上述命令生成的二进制文件位于您的 $PATH 中的某个位置。在某些系统中，这可能需要以 root 用户身份运行上述命令。

从源代码运行

或者，您可以直接使用脚本 run_saltant_cli.py 从源代码运行 saltant-cli，而不是安装它。

设置配置文件

为了运行 saltant-cli，它需要知道您的 saltant 服务器位置以及如何验证您的用户。为此，saltant-cli 会查找位于 $XDG_CONFIG_HOME/saltant-cli/config.yaml 的配置文件；如果 $XDG_CONFIG_HOME 未定义，则使用 $HOME/.config。或者，您可以使用项目仓库根目录下的 config.yaml 文件，这在从源代码运行时非常有用。

设置配置文件的最简单方法是运行

saltant-cli --setup

它会交互式地构建并写入配置文件到 $XDG_CONFIG_HOME/saltant-cli/config.yaml。

或者，您可以将示例配置文件 config.yaml.example 复制到需要的位置，并用您喜欢的文本编辑器填写文件

mkdir -p $XDG_CONFIG_HOME/saltant-cli
cp config.yaml.example $XDG_CONFIG_HOME/saltant-cli/config.yaml

有时同时管理多个配置文件可能更有优势；为此，您可以指定 --config-path 选项，如下所示

saltant-cli --config-path /path/to/config.yaml mycommandhere

Shell 命令补全

假设您已正常安装，即您不是从源代码运行，saltant-cli 支持 Bash、Zsh、fish 和 PowerShell 的命令补全。

要安装任何这些，请运行

saltant-cli completion install my-shell-type

其中 my-shell-type 是 bash、zsh、fish 或 powershell（或留空以使用当前 shell 类型）。

用法

在这里，您会发现 --help 是您的最佳朋友。在命令树的任何阶段运行它，以了解更多关于如何操作的信息！

命令树

以下是您可以做的事情的概览。再次强调，在任意时刻使用 --help 可以了解如何使用特定的命令。

saltant-cli
├── completion
│   └── install
├── container-task-instances
│   ├── clone
│   ├── create
│   ├── get
│   ├── list
│   ├── terminate
│   └── wait
├── container-task-types
│   ├── create
│   ├── get
│   ├── list
│   └── put
├── executable-task-instances
│   ├── clone
│   ├── create
│   ├── get
│   ├── list
│   ├── terminate
│   └── wait
├── executable-task-types
│   ├── create
│   ├── get
│   ├── list
│   └── put
├── task-queues
│   ├── create
│   ├── get
│   ├── list
│   └── put
├── task-whitelists
│   ├── create
│   ├── get
│   ├── list
│   └── put
└── users
    ├── get
    └── list

示例

让我们通过一些示例来了解。首先，让我们使用一些 API 过滤器列出一些容器任务类型

saltant-cli container-task-types list --filters '{"user_username_in": ["matt", "daniel"]}'

太好了！这将显示由 Matt 和 Daniel 创建的容器任务类型！其次，让我们创建一个任务队列

saltant-cli task-queues create --name "amazing-task-queue" --description "Seriously best task queue ever."

如果我们对如何使用此命令感到困惑，我们只需要输入 --help。第三：让我们这样做

saltant-cli task-queues create --help

这将给我们

$ saltant-cli task-queues create --help
Usage: saltant-cli task-queues create [OPTIONS]

  Create a task queue.

Options:
  --name TEXT         The name of the task queue.  [required]
  --description TEXT  A description of the task queue.
  --private BOOLEAN   Whether the task queue is exclusive to the creator.
                      [default: False]
  --active BOOLEAN    Whether the task queue is active.  [default: True]
  --help              Show this message and exit.

另请参阅

saltant-py，一个用于 Python 的 saltant SDK。