Package: saltant-cli
saltant CLIsaltant-cli is a CLI forsaltantwritten on top ofsaltant-py.  It lets you
interface with a saltant API conveniently from a terminal.InstallationUsing pip,pip install saltant-clior, from source, after cloning this repository, runpython setup.py installwherepythonis in versions 2.7 or 3.5+.However you chose to install saltant-cli, make sure that the binary
resulting from the above commands are somewhere on your$PATH. On some
systems, this may involve running the above commands as root.Running from sourceAlternatively, instead of installing saltant-cli you can run it directly
from source using the scriptrun_saltant_cli.py.Setting up a configuration fileIn order to run saltant-cli, it needs to know where your saltant server
is and how to authenticate your user. To get this information,
saltant-cli looks for a config file located at$XDG_CONFIG_HOME/saltant-cli/config.yaml; if$XDG_CONFIG_HOMEisn't
defined,$HOME/.configis used instead. Alternatively, you can use aconfig.yamlfile at the root of the project's repository, which is
useful when running from source.The easiest way to set up a config file is to runsaltant-cli --setupwhich interactively constructs and writes a config file to$XDG_CONFIG_HOME/saltant-cli/config.yaml.Alternatively, you can copy the example config file,config.yaml.example, to where it needs to go,
and fill in the file with your favourite text editor:mkdir -p $XDG_CONFIG_HOME/saltant-cli
cp config.yaml.example $XDG_CONFIG_HOME/saltant-cli/config.yamlThere may be times where it is advantageous to juggle multiple config
files; to do so, you can specify the--config-pathoption, like so:saltant-cli --config-path /path/to/config.yaml mycommandhereShell command completionAssuming you installed normally, i.e., you aren't running from source,
saltant-cli supports command completion forBash,Zsh,fish, andPowerShell.To install any of these, runsaltant-cli completion install my-shell-typewheremy-shell-typeis eitherbash,zsh,fish, orpowershell(or blank if you want to use the current shell type).UsageHere you're going to find--helpyour best friend. Run this at any
stage of the command tree to learn more about what to do!Commmand treeHere's a sketch of what you can do. Again, supply--helpat any point
to figure out how to use a given command.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
    └── listExamplesLet's go through a few examples. First, let's list some container task
types using some API filters:saltant-cli container-task-types list --filters '{"user_username_in": ["matt", "daniel"]}'Great! This will show us the container task types created by Matt and
Daniel! Secondly, let's create a task queue:saltant-cli task-queues create --name "amazing-task-queue" --description "Seriously best task queue ever."If we got confused about how to use this command, all we need to do is
drop in--help. Thirdly: let's do just that:saltant-cli task-queues create --helpwhich will give us$ 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.See alsosaltant-py, a saltant SDK
for Python.