Skip to content

Commit 6b9a947

Browse files
committed
update README with licensing command
1 parent 59478a3 commit 6b9a947

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ SPDX-License-Identifier: Apache-2.0
2929
- **SBOM Enrichment**: Enhance an existing SBOM with detailed licensing and copyright information using ClearlyDefined data.
3030
- **SBOM Parsing**: Extract specific information from a CycloneDX SBOM.
3131
- **License and Copyright Information Retrieval**: Fetch licensing and copyright details for a single package from ClearlyDefined.
32+
- **License compliance support**: Extract and unify licenses from SBOM, suggest possible license outbound candidates
3233

34+
Some of these features are made possible by excellent programs such as [flict](https://github.com/vinland-technology/flict) and [cdxgen](https://github.com/CycloneDX/cdxgen).
3335

3436
## Requirements
3537

@@ -110,6 +112,7 @@ For each command, you can get detailed options, e.g. `compliance-assistant sbom-
110112
* Enrich an SBOM with ClearlyDefined data: `compliance-assistant sbom-enrich -f /tmp/my-sbom.json -o /tmp/my-enriched-sbom.json`
111113
* Extract certain data from an SBOM: `compliance-assistant sbom-parse -f /tmp/my-enriched-sbom.json -e purl,copyright,name`
112114
* Gather ClearlyDefined licensing/copyright information for one package: `compliance-assistant clearlydefined -p pkg:pypi/[email protected]`
115+
* Get license outbound candidate based on licenses from SBOM: `compliance-assistant licensing outbound -f /tmp/my-enriched-sbom.json`
113116

114117
### Run as GitHub workflow
115118

0 commit comments

Comments
 (0)