search

interlynk-io / sbomqs

SBOM quality score - Quality metrics for your sboms
Apache License 2.0
158 stars 20 forks source link

Improve Help Output for sbomqs score Command #297

Closed viveksahu26 closed 3 weeks ago

viveksahu26 commented 1 month ago

Description

The current help output for the sbomqs score command does not provide clear and concise information about the available filters of category and feature flags. It would be beneficial to include specific examples of feature and category and provide a link to a comprehensive list of all available filters. This enhancement would help users understand how to use the flag more effectively.

Current o/p

 sbomqs score -h
comprehensive quality score for your sbom

Usage:
  sbomqs score [flags]

Flags:
  -b, --basic               results in single line format
  -c, --category string     filter by category
      --configpath string   scoring based on config path
  -D, --debug               enable debug logging
  -d, --detailed            results in table format, default
  -f, --feature string      filter by feature
  -h, --help                help for score
  -j, --json                results in json

Proposed Help Output

 sbomqs score -h
comprehensive quality score for your sbom

Usage:
  sbomqs score [flags]

Flags:
  -b, --basic               results in single line format
  -c, --category string     filter by category (e.g., "NTIA-minimum-elements", "Quality", "Semantic", "Sharing", "Structural")
      --configpath string   scoring based on config path
  -D, --debug               enable debug logging
  -d, --detailed            results in table format, default
  -f, --feature string      filter by feature (e.g., "sbom_authors",  "comp_with_name", "sbom_creation_timestamp")
  -h, --help                help for score
  -j, --json                results in json

For more information on available filters for category and feature, please visit: [https://github.com/interlynk-io/sbomqs/blob/main/pkg/scorer/criteria.go]