/cyclonedx-ruby-gem

Creates CycloneDX Software Bill-of-Materials (SBoM) from Ruby projects

Primary LanguageRubyApache License 2.0Apache-2.0

Build Status Gem Version License Website Group Discussion Twitter

CycloneDX Ruby Gem

The CycloneDX Ruby Gem creates a valid CycloneDX bill-of-material document from all project dependencies. CycloneDX is a lightweight BoM specification that is easily created, human readable, and simple to parse. The resulting bom.xml can be used with tools such as OWASP Dependency-Track for the continuous analysis of components.

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
`-h, --help` Show help message

Output: bom.xml file in project directory

Example

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

Copyright & License

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