Skip to content

Commit d32fde2

Browse files
chore(documentation): Added info about command line options.
1 parent f6b8ac6 commit d32fde2

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,18 @@ The ```run()``` function will run all registered tests and report the result.
8787
Bandit enables you to tweak the way tests results are reported by allowing you to specify command
8888
line switches. Running ```[name of your executable] --help``` will list the available options.
8989

90+
```
91+
$ my-exe --help
92+
SAGE: <executable> [options]
93+
94+
Options:
95+
--version, Print version of bandit
96+
--help, Print usage and exit.
97+
--reporter, Select reporter (dots, singleline, xunit)
98+
--no-color, Suppress colors in output
99+
--formatter, Select formatting of errors (default, vs)
100+
```
101+
90102
#Writing Tests
91103

92104
Once you have a command line application with an entry point that delegates to bandit, it's time to

0 commit comments

Comments
 (0)