diff --git a/README.md b/README.md index 851387ab..e7d9fd4e 100644 --- a/README.md +++ b/README.md @@ -132,13 +132,23 @@ You can see the help of a command with `venom [command] -h`: ```bash $ venom run -h -$ venom run *.yml - -Notice that variables initialized with -var-from-file argument can be overrided with -var argument. +run integration tests Usage: venom run [flags] +Examples: + Run all testsuites containing in files ending with *.yml or *.yaml: venom run + Run a single testsuite: venom run mytestfile.yml + Run a single testsuite and export the result in JSON format in test/ folder: venom run mytestfile.yml --format=json --output-dir=test + Run a single testsuite and specify a variable: venom run mytestfile.yml --var="foo=bar" + Run a single testsuite and load all variables from a file: venom run mytestfile.yml --var-from-file variables.yaml + Run all testsuites containing in files ending with *.yml or *.yaml with verbosity: VENOM_VERBOSE=2 venom run + + Notice that variables initialized with -var-from-file argument can be overrided with -var argument + + More info: https://github.com/ovh/venom + Flags: --format string --format:yaml, json, xml, tap (default "xml") -h, --help help for run