盐基CLI
saltant-cli的Python项目详细描述
saltant cli
saltant cli是 saltant写在 saltant-py。它让你 从终端方便地与saltant api接口。
安装
使用pip，
pip install saltant-cli
或者，从源代码处克隆此存储库后，运行
python setup.py install
其中python在版本2.7或3.5+中。
不管您选择安装saltant cli，请确保
由上述命令产生的结果在$PATH中的某个位置。在一些
系统，这可能需要以根用户身份运行上述命令。
从源运行
或者，您可以直接运行saltant cli，而不是安装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。
或者，可以复制示例配置文件，
^{
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。
（如果要使用当前外壳类型，则为空）。
用法
在这里你会找到你最好的朋友。在任何时候运行这个 阶段的命令树学习更多关于做什么！
命令树
这是你能做什么的草图。再次，在任何点上提供--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和 丹尼尔！其次，我们创建一个任务队列：
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，一个saltant sdk 对于python。
欢迎加入QQ群-->： 979659372
