Skip to content

Command-Line Interface

Est Shizard provides a Command-line interface to interact with user. For example you can get a tool version from the console:

est-shizard --version

Getting help on commands#

Est Shizard provides help information for each command and program itself. See:

est-shizard -h
est-shizard run -h

Install CLI completions#

Est Shizard provides tab completion support for Bash.

Shell completion suggests command names, option names, and values for choice. Options are only listed if at least a dash has been entered.

$ est-shizard run -<TAB><TAB>
--env     --help    --lint    --report  -h

Completion is only available if a script is installed and invoked through an entry point, not through the python command. To install completions you need to run:

est-shizard est-shizard --install-completion bash

For more information about CLI commands, see Command-Line Reference.