diff options
Diffstat (limited to 'docs/testing/user/userguide/cli.rst')
| -rw-r--r-- | docs/testing/user/userguide/cli.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/testing/user/userguide/cli.rst b/docs/testing/user/userguide/cli.rst index 99efd930..8a983155 100644 --- a/docs/testing/user/userguide/cli.rst +++ b/docs/testing/user/userguide/cli.rst @@ -10,12 +10,26 @@ QTIP consists of a number of benchmarking tools or metrics, grouped under QPI's. components of a NFVI ecosystem, such as compute, network and storage. Depending on the type of application, a user may group them under plans. +Bash Command Completion +======================= + +To enable command completion, an environment variable needs to be enabled. +Add the following line to the **.bashrc** file +:: + + eval "$(_QTIP_COMPLETE=source qtip)" + +Getting help +============ + QTIP CLI provides interface to all of the above the components. A help page provides a list of all the commands along with a short description. :: qtip [-h|--help] +Usage +===== Typically a complete plan is executed at the target environment. QTIP defaults to a number of sample plans. A list of all the available plans can be viewed :: @@ -55,6 +69,9 @@ the results are stored. Extending the example above qtip report show <metric_name> -p $PWD/result +Debugging options +================= + Debug option helps identify the error by providing a detailed traceback. It can be enabled as :: |