Skip to content

Commit 32a62cd

Browse files
docs: Clarifying use of --metrics and epss options (#3663)
Co-authored-by: Terri Oda <[email protected]>
1 parent f772954 commit 32a62cd

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

cve_bin_tool/cli.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,12 +278,12 @@ def main(argv=None):
278278
output_group.add_argument(
279279
"--epss-percentile",
280280
action="store",
281-
help="minimum epss percentile of CVE range between 0 to 100 to report",
281+
help="minimum epss percentile of CVE range between 0 to 100 to report. Automatically enables `--metrics`",
282282
)
283283
output_group.add_argument(
284284
"--epss-probability",
285285
action="store",
286-
help="minimum epss probability of CVE range between 0 to 100 to report",
286+
help="minimum epss probability of CVE range between 0 to 100 to report. Automatically enables `--metrics`",
287287
)
288288
output_group.add_argument(
289289
"--no-0-cve-report",

doc/MANUAL.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1080,6 +1080,10 @@ This option specifies the minimum EPSS percentile of CVE range between 0 to 100
10801080

10811081
This option specifies the minimum EPSS probability of CVE range between o to 100 to report. The default value is 0 which result in all CVEs being reported.
10821082

1083+
### Automatic Metrics Activation
1084+
1085+
If either `--epss-percentile` or `--epss-probability` is set, the system will automatically enable the `--metrics` option so that the epss data will be loaded and displayed.
1086+
10831087
### -S {low,medium,high,critical}, --severity {low,medium,high,critical}
10841088

10851089
This option specifies the minimum CVE severity to report. The default value is low which results in all CVEs being reported.

0 commit comments

Comments
 (0)