Chapter 5
Commands
The qaskx-cli program has a common command structure, formed with commands and subcommands,
followed by options. The options vary for each command and subcommand, though there is
consistency in the option names and purpose.
Options or additional arguements to the command are prefixed with a single “-” for short one character codes or double “–” for longer names.
The below pages describe the commands for qaskx-cli in more detail. The commands
have further details on the subcommands where applicable.
- 5.1 Common Options
- 5.2 Logo
- 5.3 Version
- 5.4 Configuration
- 5.5 Setup
- 5.6 rediops
- 5.7 Definition
- 5.8 Generate
- 5.9 Run
- 5.10 Serve
The command help is shown below.
Usage: qaskx-cli [-v | --vv | --vvv | --silent] [-c=<conf file>] [--colourCLI] [--offline] [--env=<environment file>] COMMAND [arg...]
The qaskx command line tool is for performing many rediOps tasks
from a command line without a user interface. A use case is
the execution of the tasks from a script file, such as the
scanning for updated configuration files.
The tool is written in Golang and is therefore portable
to many environments.
For more details see the documentation at https://docs.qaskx.one/qaskx-cli/ .
Options:
--version Show the version and exit
-v, --verbose Verbose logging
--vv Verbose logging level 3
--vvv Verbose logging level 5
--silent Silent running
--env Environment file to use (default ".env")
--colourCLI Colour terminal and command line (env $QASKX_COLOUR_CLI)
-c, --conf Configuration file (env $QASKX_CONFIG_FILE)
--offline Offline mode (env $QASKX_OFFLINE)
Commands:
logo Show logo
help Provide basic help
rediops rediOps definition functions
definition, def OpenApi / AsyncApi management processes
generate, gen Generate artifacts from rediOps & OpenAPI definitions
run Execute the defined rediOps function
serve qaskx functional server commands
setup Setup qaskx-cli
Run 'qaskx-cli COMMAND --help' for more information on a command.