5.1 Common Options
There are common options applicable for most commands in qaskx-cli
The common options are boolean values, normally off. The options are prefixed
with -- for the long form or - for short form which are single characters.
The common options are:
| Long form | Short form | Description |
|---|---|---|
| –help | -h | Help for a command or subcommand |
| –verbose | -v | Verbose logging. More messages are displayed during execution |
| –vv | Verbose logging and log level set to 3 for this execution | |
| –vvv | Verbose logging and log level set to 5 for this execution | |
| –silent | Silent running. Reduces the number of messages issued to zero or near zero. This ovverrides the verbose option | |
| –colourCLI | Colour terminal output is produced where possible. You can also set “true” for the environment variable QASKX_COLOUR_CLI | |
| –offline | Operate in off-line mode which impacts ability to get remote content such as templates |
Another option for use by itself is the –version
Online
The CLI does contact the central server for updates, policies and templates. If you are running your own server and setup with policy enabled, different servers can supply the material.
For example the software update can be to the https://qaskx.one site but the templates could be an iternal server.
The purpose of the online option is to allow fetch of common, shared settings with our team or department.
As such different defaults and policies can be defined.
See policy for more details.
Environmental Variables
The commands also can get arguent values from enviromental variables. The enviromental values are used if available and no command line values supplied.
You can get the list of enviromental variables by executing the below command.
qaskx-cli setup print --tag environment --silent
The output is the supported environment variables. Not all environmental variables are valid for all commands.
Environment variables for commands are:
QASKX_CONFIG_FILE - config file path current value: ''
QASKX_SERVERCONFIG_FILE - server config file path current value: ''
QASKX_LOGO - logo display or silent 0/1 current value: ''
QASKX_COLOUR_CLI - use terminal colours 0/1 current value: ''
QASKX_BARE_CLI - bare CLI 0/1 current value: ''
QASKX_MAPPING_FILE - mapping configuration file current value: ''
QASKX_VCS_PASSwORD - VCS password value
QASKX_VCS_TOKEN - VCS token value such as used by Github
QASKX_TEMPLATE_FOLDER - template folder location current value: ''
QASKX_OFFLINE - offline 0/1 current value: ''