Skip to content

Commit da5ee92

Browse files
committed
Update Readme: Add new parameters
Also add aliases to existing parameters
1 parent 4317e4e commit da5ee92

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -86,15 +86,15 @@ utplsql run "my/Username"/"myP@ssword"@connectstring
8686
#### Options
8787
```
8888
-p=suite_path(s) - A suite path or a comma separated list of suite paths for unit test to be executed.
89-
The path(s) can be in one of the following formats:
89+
(--path) The path(s) can be in one of the following formats:
9090
schema[.package[.procedure]]
9191
schema:suite[.suite[.suite][...]][.procedure]
9292
Both formats can be mixed in the list.
9393
If only schema is provided, then all suites owner by that schema are executed.
9494
If -p is omitted, the current schema is used.
9595
9696
-f=format - A reporter to be used for reporting.
97-
If no -f option is provided, the default ut_documentation_reporter is used.
97+
(--format) If no -f option is provided, the default ut_documentation_reporter is used.
9898
See reporters command for possible values
9999
-o=output - Defines file name to save the output from the specified reporter.
100100
If defined, the output is not displayed on screen by default. This can be changed with the -s parameter.
@@ -119,12 +119,14 @@ utplsql run "my/Username"/"myP@ssword"@connectstring
119119
-name_subexpression=subexpression_number
120120
121121
-c - If specified, enables printing of test results in colors as defined by ANSICONSOLE standards.
122-
Works only on reporeters that support colors (ut_documentation_reporter).
122+
(--color) Works only on reporeters that support colors (ut_documentation_reporter).
123123
124-
--failure-exit-code - Override the exit code on failure, defaults to 1. You can set it to 0 to always exit with a success status.
124+
-fcode=code - Override the exit code on failure, defaults to 1. You can set it to 0 to always exit with a success status.
125+
(--failure-exit-code)
125126
126127
-scc - If specified, skips the compatibility-check with the version of the database framework.
127-
If you skip compatibility-check, CLI will expect the most actual framework version
128+
(--skip- If you skip compatibility-check, CLI will expect the most actual framework version
129+
compatibility-check)
128130
129131
-include=pckg_list - Comma-separated object list to include in the coverage report.
130132
Format: [schema.]package[,[schema.]package ...].
@@ -135,13 +137,16 @@ utplsql run "my/Username"/"myP@ssword"@connectstring
135137
See coverage reporting options in framework documentation.
136138
137139
-q - Does not output the informational messages normally printed to console.
138-
Default: false
140+
(--quiet) Default: false
139141
140142
-d - Outputs a load of debug information to console
141-
Default: false
143+
(--debug) Default: false
142144
143-
-t - Sets the timeout in minutes after which the cli will abort.
144-
Default 60
145+
-t=timeInMinutes - Sets the timeout in minutes after which the cli will abort.
146+
(--timeout) Default 60
147+
148+
-dbout - Enables DBMS_OUTPUT in the TestRunner-Session
149+
(--dbms_output) Default: false
145150
```
146151

147152
Parameters -f, -o, -s are correlated. That is parameters -o and -s are controlling outputs for reporter specified by the preceding -f parameter.

0 commit comments

Comments
 (0)