Skip to content

Commit 0b4b40f

Browse files
committed
Update documentation to reflect addition of json formatting
1 parent af11b1e commit 0b4b40f

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

MANUAL.md

+5
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ Possible output levels:
1818
Other options:
1919
```
2020
-h, --help show help message and exit
21+
-f {csv,json}, --format {csv,json}
22+
output format (default: csv)
2123
-x, --extract autoextract compressed files
2224
-s SKIPS, --skips SKIPS
2325
comma-separated list of checkers to disable
@@ -144,6 +146,9 @@ Options:
144146

145147
This option allows the CVE Binary Tool to extract compressed files into a temporary directory so the contents can be scanned. If the quiet flag is not used, the list of extracted files will be printed.
146148

149+
### -f {csv,json}, --format {csv,json}
150+
This options controls the format of the final output produced by the CVE Binary Tool. This can be useful if you have particular output requirements, for example, if you already have a separate reporting tool that only takes JSON.
151+
147152
### -s SKIPS, --skips SKIPS
148153

149154
This option allows one to skip (disable) a comma-separated list of checkers. This can be useful for improving the performance of the tool when you have some prior knowledge about what checkers may apply to the binary you are scanning.

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ You can also do `python -m cve_bin_tool.cli <flags> <path to directory>` which i
3131
log level. The default log level is info
3232
3333
Functional options:
34+
-f {csv,json}, --format {csv,json}
35+
output format (default: csv)
3436
-x, --extract autoextract compressed files
3537
-s SKIPS, --skips SKIPS
3638
comma-separated list of checkers to disable

0 commit comments

Comments
 (0)