CLI Application¶
Arguments¶
Scenario YAML file paths.
When given none, the standard input is used instead and the current directory is regarded as the base directory.
Options¶
Short |
Long |
Type |
Description |
Default |
---|---|---|---|---|
|
|
Show the help message and exit. |
||
|
Show program’s version number and exit. |
|||
|
|
string |
Set the base URL. |
|
|
|
Show only above or equal to this level on the console (cannot affect other reports.) |
success |
|
|
|
int |
Set the max retry count. |
0 |
|
|
float |
Set the delay between attempts in seconds. |
0.1 |
|
|
float |
Set the request timeout in seconds. |
no timeout |
|
|
int |
Set the request concurrency. |
1 |
|
|
string |
Set the report directory. (experimental) |
no report |
Level¶
Allowed values are:
skipped
success
unstable
failure
Environment Variables Interface¶
Using commandline options bother us in some situation like:
Giving CI build parameters to Preacher.
Wrapping Preacher execution with shell scripts.
Alternatively, Preacher supports environment variables that are equivalent to commandline options.
Name |
Equivalent to |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Environment variables that have empty strings are ignored. This behavior is useful to handle optional settings.
Preacher requests your server using requests,
which allows you to pass environment variables that requests supports.
For example, when you want to proxy requests,
you can achieve it by HTTP_PROXY
or HTTPS_PROXY
variable.
$ HTTP_PROXY=http://proxy.com:3128 preacher-cli scenario.yml