Skip to content

docs: Clarifying use of --metrics and epss options #3663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 3, 2024
Merged

docs: Clarifying use of --metrics and epss options #3663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dcdc7ac
doc update
Mayankrai449 Dec 23, 2023
90972cb
Merge branch 'main' into mayankrai/docs_update
terriko Dec 28, 2023
c1c91b8
Update cve_bin_tool/cli.py
Mayankrai449 Dec 28, 2023
f758589
Update doc/MANUAL.md
Mayankrai449 Dec 28, 2023
ed97c4c
Merge branch 'main' into mayankrai/docs_update
terriko Dec 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cve_bin_tool/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,12 +278,12 @@ def main(argv=None):
output_group.add_argument(
"--epss-percentile",
action="store",
help="minimum epss percentile of CVE range between 0 to 100 to report",
help="minimum epss percentile of CVE range between 0 to 100 to report. Automatically enables `--metrics`",
)
output_group.add_argument(
"--epss-probability",
action="store",
help="minimum epss probability of CVE range between 0 to 100 to report",
help="minimum epss probability of CVE range between 0 to 100 to report. Automatically enables `--metrics`",
)
output_group.add_argument(
"--no-0-cve-report",
Expand Down
4 changes: 4 additions & 0 deletions doc/MANUAL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1080,6 +1080,10 @@ This option specifies the minimum EPSS percentile of CVE range between 0 to 100

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.

### Automatic Metrics Activation

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.

### -S {low,medium,high,critical}, --severity {low,medium,high,critical}

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