You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A lot of yardstick commands accept something like DESCRIPTION or ID, but it's not obvious what this string is. Example:
❯ yardstick label explore --help
Usage: yardstick label explore [OPTIONS] DESCRIPTION
interact with an label results for a single image scan
Options:
-y, --year-max-limit TEXT max year to include in comparison (relative
to the CVE ID)
-c, --derive-year-from-cve-only
only use the CVE ID year-max-limit
--help Show this message and exit.
In this case, DESCRIPTION is really a result set UUID obtained by running yardstick result list and looking for the image+tool combo the user is interested in. But nothing about DESCRIPTION makes it obvious what to pass in our how to get it.
Why is this needed:
The use of generic parameter names like ID and DESCRIPTION in the docs makes it very hard to come up to speed in yardstick.
Additional context:
The text was updated successfully, but these errors were encountered:
❯ yardstick label apply --help
Usage: yardstick label apply [OPTIONS] RESULT_ID
see which labels apply to the given image and tool pair
Options:
-i, --inverse show image lables that should not be applied
--id show IDs only
-y, --year-max-limit TEXT max year to include in comparison (relative
to the CVE ID)
-c, --derive-year-from-cve-only
only use the CVE ID year-max-limit
--help Show this message and exit.
I assume that --id shows only image IDs, (as opposed to docker tags or whatever?) but this isn't 100% clear from the help text.
Another example:
❯ yardstick label compare --help
Usage: yardstick label compare [OPTIONS] [DESCRIPTIONS]...
compare a scan result against labeled data
Options:
--show-fns show all FN labels for each tool-image pair
--show-indeterminates show each indeterminate result for each tool-
image pair
--fuzzy loosen restrictions on package matching
-r, --result-set TEXT use a named result set as description input
-y, --year-max-limit TEXT max year to include in comparison (relative to
the CVE ID)
-j, --json show results as JSON
--help Show this message and exit.
Descriptions of what? What's a description, and where do I get it?
What would you like to be added:
A lot of yardstick commands accept something like
DESCRIPTION
orID
, but it's not obvious what this string is. Example:In this case,
DESCRIPTION
is really a result set UUID obtained by runningyardstick result list
and looking for the image+tool combo the user is interested in. But nothing aboutDESCRIPTION
makes it obvious what to pass in our how to get it.Why is this needed:
The use of generic parameter names like
ID
andDESCRIPTION
in the docs makes it very hard to come up to speed in yardstick.Additional context:
The text was updated successfully, but these errors were encountered: