Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@jackton1
jackton1 authored Jan 2, 2023
1 parent 7941557 commit 66a1d6c
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,10 @@ Support this project with a :star:
<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|---------|--------|----------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| options | string | false | `"-r"` | optional arguments: -h, --help show this<br> help message and exit -r, --recursive<br> find and process files in subdirectories<br> -a {file,vuln}, --aggregate {file,vuln} aggregate output<br> by vulnerability (default) or by filename<br> -n CONTEXT\_LINES, --number CONTEXT\_LINES maximum number<br> of code lines to output for<br> each issue -c CONFIG\_FILE, --configfile CONFIG\_FILE<br> optional config file to use for<br> selecting plugins and overriding defaults -p<br> PROFILE, --profile PROFILE profile to use<br> (defaults to executing all tests) -t<br> TESTS, --tests TESTS comma-separated list of<br> test IDs to run -s SKIPS,<br> --skip SKIPS comma-separated list of test<br> IDs to skip -l, --level report<br> only issues of a given severity<br> level or higher (-l for LOW,<br> -ll for MEDIUM, -lll for HIGH)<br> -i, --confidence report only issues of<br> a given confidence level or higher<br> (-i for LOW, -ii for MEDIUM,<br> -iii for HIGH) -f {csv,custom,html,json,screen,txt,xml,yaml}, |
| | | | | --format<br> {csv,custom,html,json,screen,txt,xml,yaml} specify output format --msg-template MSG\_TEMPLATE<br> specify output message template (only usable<br> with --format custom), see CUSTOM FORMAT<br> section for list of available values<br> -o \[OUTPUT\_FILE], --output \[OUTPUT\_FILE] write report<br> to filename -v, --verbose output extra<br> information like excluded and included files<br> -d, --debug turn on debug mode<br> -q, --quiet, --silent only show output<br> in the case of an error<br> --ignore-nosec do not skip lines with<br> # nosec comments -x EXCLUDED\_PATHS, --exclude<br> EXCLUDED\_PATHS comma-separated list of paths (glob<br> patterns supported) to exclude from scan<br> (note that these are in addition<br> to the excluded paths provided in<br> the config file) (default: .svn,CVS,.bzr,.hg,.git,**pycache**,.tox,.eggs,\*.egg) -b<br> BASELINE, --baseline BASELINE path of a<br> baseline report to compare against (only<br> JSON-formatted files are accepted) --ini INI\_PATH<br> |
| | | | | path to a .bandit file that<br> supplies command line arguments --exit-zero exit<br> with 0, even with results found<br> --version show program's version number and<br>exit |
| targets | string | true | `"."` | Module(s)/Package(s) to run bandit checks |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|---------|--------|----------|---------|---------------------------------------------------------------------------------------------------|
| options | string | false | `"-r"` | Extra options passed directly to bandit.<br>See: [OPTIONS.md for available choices](./OPTIONS.md) |
| targets | string | true | `"."` | Module(s)/Package(s) to run bandit checks |
<!-- AUTO-DOC-INPUT:END -->
Expand Down

0 comments on commit 66a1d6c

Please # to comment.