search

CycloneDX / cyclonedx-ruby-gem

Creates CycloneDX Software Bill of Materials (SBOM) from Ruby projects
https://cyclonedx.org/
Apache License 2.0
21 stars 20 forks source link
bill-of-materials bom bundler cyclonedx gem mbom obom owasp package-url purl ruby saasbom sbom sbom-generator software-bill-of-materials spdx vex

readme

Build Status Gem Version License Website Slack Invite Group Discussion Twitter

CycloneDX Ruby Gem

The CycloneDX Ruby Gem creates a valid CycloneDX Software Bill of Materials (SBOM) from all project dependencies. CycloneDX is a lightweight SBOM specification that is easily created, human readable, and simple to parse.

Installing from RubyGems

gem install cyclonedx-ruby

Building and Installing From Source

gem build cyclonedx-ruby.gemspec
gem install cyclonedx-ruby-x.x.x.gem

Usage

cyclonedx-ruby [options]

`-v, --[no-]verbose` Run verbosely
`-p, --path path` Path to Ruby project directory
`-f, --format` Bom output format
`-h, --help` Show help message

Output: bom.xml or bom.json file in project directory

Example

cyclonedx-ruby -p /path/to/ruby/project

Copyright & License

CycloneDX Ruby Gem is Copyright (c) OWASP Foundation. All Rights Reserved.

Permission to modify and redistribute is granted under the terms of the Apache 2.0 license. See the LICENSE file for the full license.