Skip to content

Creates CycloneDX Software Bill-of-Materials (SBOM) from Objective-C and Swift Projects Using CocoaPods

License

Notifications You must be signed in to change notification settings

vessosa/cyclonedx-cocoapods

 
 

Repository files navigation

Build Status Gem Version License Website Slack Invite Group Discussion Twitter

CycloneDX CocoaPods (Objective-C/Swift)

The CycloneDX CocoaPods 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.

Installing from RubyGems

% gem install cyclonedx-cocoapods

Building and Installing From Source

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

Usage

Usage: cyclonedx-cocoapods [options]

    --[no-]verbose               Run verbosely
-p, --path path                  (Optional) Path to CocoaPods project directory, current directory if missing
-o, --output bom_file_path       (Optional) Path to output the bom.xml file to
-b, --bom-version bom_version    (Optional) Version of the generated BOM, 1 if not provided
-g, --group group                (Optional) Group of the component for which the BOM is generated
-n, --name name                  (Optional, if specified version and type are also required) Name of the component for which the BOM is generated
-v, --version version            (Optional) Version of the component for which the BOM is generated
-t, --type type                  (Optional) Type of the component for which the BOM is generated (one of application|framework|library|container|operating-system|device|firmware|file)
-h, --help                       Show help message

Output: BoM file at specified location, ./bom.xml if not specified

Example

% cyclonedx-cocoapods --path /path/to/cocoapods/project --output /path/to/bom.xml --version 6 

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.

About

Creates CycloneDX Software Bill-of-Materials (SBOM) from Objective-C and Swift Projects Using CocoaPods

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 99.8%
  • Shell 0.2%