Skip to content
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.

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

update compliance docs #341

Merged

Conversation

viveksahu26
Copy link
Collaborator

This PR update documentation for compliance.

$ go run main.go compliance -h                                           

Check if our SBOM meets compliance requirements for various standards, such as NTIA minimum elements, 
BSI TR-03183-2, Framing Software Component Transparency (v3) and OpenChain Telco.

Usage:
  sbomqs compliance [flags]

Examples:
 sbomqs compliance <--ntia | --bsi | --fsct | --oct > [--basic | --json] <SBOM file>

  # Check a NTIA minimum elements compliance against a SBOM in a table output
  sbomqs compliance --ntia samples/sbomqs-spdx-syft.json

  # Check a BSI TR-03183-2 v1.1 compliance against a SBOM in a table output
  sbomqs compliance --bsi samples/sbomqs-spdx-syft.json

   # Check a Framing Software Component Transparency (v3) compliance against a SBOM in a table output
  sbomqs compliance --fsct samples/sbomqs-spdx-syft.json

  # Check a OpenChain Telco compliance against a SBOM in a JSON output
  sbomqs compliance --oct --json samples/sbomqs-spdx-syft.json

   # Check a Framing Software Component Transparency (v3) compliance against a SBOM in a table colorful output
  sbomqs compliance --fsct --color samples/sbomqs-spdx-syft.json



Flags:
  -b, --basic      output in basic format
  -c, --bsi        BSI TR-03183-2 (v1.1)
  -l, --color      output in colorful
  -D, --debug      debug logging
  -d, --detailed   output in detailed format(default)
  -f, --fsct       Framing Software Component Transparency (v3)
  -h, --help       help for compliance
  -j, --json       output in json format
  -n, --ntia       NTIA minimum elements (July 12, 2021)
  -t, --oct        OpenChain Telco SBOM (v1.0)

Signed-off-by: Vivek Kumar Sahu <[email protected]>
@riteshnoronha riteshnoronha merged commit 1bdd771 into interlynk-io:main Nov 3, 2024
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants