Skip to main content

CycloneDX SBOM

CycloneDX

Creates software bills of materials (SBOM) in the CycloneDX format.

Configuration​

Example​

Use the following syntax to configure this plugin globally as part of config.yml:

ort:
  reporter:
    reporters:
      CycloneDX:
        options:
          schemaVersion: "1.6"
          dataLicense: "CC0-1.0"
          singleBom: true
          outputFileFormats: "JSON"

Options​

schemaVersion​

STRING Default

The CycloneDX schema version to use. Defaults to "1.6".

dataLicense​

STRING Default

The license for the data contained in the report. Defaults to "CC0-1.0".

singleBom​

BOOLEAN Default

If true (the default), a single SBOM for all projects is created; if set to false, separate SBOMs are created for each project.

outputFileFormats​

STRING_LIST Default

A comma-separated list of (case-insensitive) output formats to export to. Supported are XML and JSON.