stepbro.exe ‐ the console application - JanJorgensen/StepBro GitHub Wiki
The stepbro.exe console application is used to execute scripts.
Typical use
When using stepbro.exe to execute a script, the following will happen:
- StepBro.Core is initialized
- External code modules are loaded
- Specified script file is loaded
- The script file is parsed
- All dependency script files are loaded.
- All script files are parsed to check for errors.
- Runtime code and data is created.
- The specified file element is executed, maybe through a specified model.
- During or after the script execution, the execution log can optionally be output to the console.
- Result files are optionally created (test report and execution log) efter ended script execution.
Command-line Options
| Option | Description | Additional Note |
|---|---|---|
| -v, --verbose | Prints StepBro setup information, execution log and execution results to the console. | Defaults to false |
| -t, --trace | Prints execution log to the console. (Deprecated use -l or --log instead) | Defaults to false |
| -l, --log | Prints execution log to the console. | Defaults to false |
| --save_log | Saves the entire execution log in a text file in the specified folder. | |
| --save_report | Saves the generated execution/test report(s) in the specified text file. | |
| --print_report | Prints the generated execution/test report in the text format selected by the 'format' option. | Defaults to false |
| --format | Format of the console output. (AzureLog, Console, HTML, or SimpleCleartext) | When used, the execution log will be printed, and the 'trace' option is not necessary, defaults to Console |
| --logfileformat | Format of created execution log files. | |
| -w, --wait | Awaits key press before terminating. | Defaults to false |
| --repeat_parsing | Repeatedly parsing top file and the dependancy files whenever a file changes. | Defaults to false |
| --exitcode | Application exit code option (Normal, ReturnValue, Verdict or SubVerdict). | Defaults to Normal |
| --no_attach | Only usable with --sidekick. Makes sidekick not attach to console, useful if running with a non-supported terminal such as Win11 Terminal or VSCode. | Defaults to false |
| -d, --debug | Sets StepBro to debugging mode. | |
| -e, --execute | File element (procedure or test suite) to execute. | |
| -i, --instance | Object/variable instance to use for the file element to execute. | |
| -m, --model | Model procedure to handle the execution of the target element. A model is a partner procedure used to execute the element through, instead of directly executing the element directly (a testlist can't be executed directly). | Look at TestFramework.sbs for models |
| -a, --arguments | Arguments for the specified procedure to be called. If more than one argument, the arguments must be comma separated. | |
| --help | Display this help screen. | |
| --version | Display version information. | |
| file (pos. 0) | Script file to load. |