CycloneDX/cyclonedx-ruby-gem
GitHub: CycloneDX/cyclonedx-ruby-gem
为 Ruby 项目自动生成符合 CycloneDX 规范的软件物料清单(SBOM)的命令行工具。
Stars: 36 | Forks: 21
# CycloneDX Ruby Gem
[![shield_rubygems]][link_rubygems]
[![shield_gh-workflow-test]][link_gh-workflow-test]
[![shield_coverage]][link_codacy]
[![shield_license]][license_file]
[![shield_website]][link_website]
[![shield_slack]][link_slack]
[![shield_groups]][link_discussion]
[![shield_twitter-follow]][link_twitter]
CycloneDX Ruby Gem 会根据项目的所有依赖生成有效的 CycloneDX 软件物料清单 (SBOM)。CycloneDX 是一个轻量级的 SBOM 规范,易于创建、人类可读且解析简单。
#### 从 RubyGems 安装
```
gem install cyclonedx-ruby
```
#### 从源码构建并安装
```
gem build cyclonedx-ruby.gemspec
gem install cyclonedx-ruby-x.x.x.gem
```
#### 用法
cyclonedx-ruby [options]
```
`-v, --[no-]verbose` Run verbosely
`-p, --path path` Path to Ruby project directory
`-o, --output bom_file_path` Path to output the bom file
`-f, --format bom_output_format` Output format for bom. Supported: xml (default), json
`-s, --spec-version version` CycloneDX spec version to target (default: 1.7). Supported: 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7
`-h, --help` Show help message
```
**输出:** 项目目录中的 bom.xml 或 bom.json 文件
- 默认情况下,输出符合 CycloneDX 规范版本 1.7。
- 要生成较旧的规范版本,请使用 `--spec-version`。
#### 示例
```
# 默认 (XML, CycloneDX 1.7)
cyclonedx-ruby -p /path/to/ruby/project
# CycloneDX 1.7 的 JSON
cyclonedx-ruby -p /path/to/ruby/project -f json
# CycloneDX 1.3 的 XML
cyclonedx-ruby -p /path/to/ruby/project -s 1.3
# 将 CycloneDX 1.2 的 JSON 输出到自定义路径
cyclonedx-ruby -p /path/to/ruby/project -f json -s 1.2 -o bom/out.json
```
## 版权与许可
CycloneDX Ruby Gem 版权所有 (c) OWASP Foundation。保留所有权利。
在 Apache 2.0 许可证的条款下授予修改和重新分发的权限。完整的许可证请参阅 [LICENSE][license_file] 文件。
标签:CycloneDX, LLM防护, Ruby, SBOM, SOC Prime, 依赖管理, 动态分析, 开发工具, 知识库, 硬件无关