Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

iTechGuides is reader-supported. When you buy through links on our site, we may earn an affiliate commission. As an Amazon Associate I earn from qualifying purchases. Learn more

CycloneDX CLI is a command-line toolkit for processing CycloneDX and related BOM documents. Use it to analyze a BOM, compare or merge documents, convert supported formats, add file information, validate JSON or XML, or sign and verify documents. It is designed for scripted workflows, but it should not be treated as a general-purpose source-code or dependency scanner.

What CycloneDX CLI does

The project README describes commands for working with existing BOM documents and adding file information. Its add files example can generate a source-code BOM from files; that does not establish that the CLI scans projects for dependencies or replaces a dedicated scanner. The documented command set includes analyze, diff, merge, convert, add files, validate, sign, and verify. See the official project README for the current command list.

Choose a command by the job

Task Command What it is for
Inspect or examine a BOM analyze Analyze a BOM document.
Compare two BOMs diff Show differences between documents.
Combine BOM documents merge Merge documents into a combined document.
Change document format convert Convert among documented formats, subject to the command’s input and output options.
Add file information add files Add file information; the README also demonstrates generating a source-code BOM from files.
Check a document against a specification version validate Validate JSON or XML input using a selectable CycloneDX specification version.
Apply or check a signature sign or verify Sign a BOM or verify a signature.

These are different workflow choices, not interchangeable ways to perform one universal operation. Check the installed command’s help for required arguments and supported options.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Convert a BOM between supported formats

The README lists CycloneDX XML, JSON, Protobuf, and CSV, as well as SPDX JSON v2.3, among conversion formats. That conversion list should not be mistaken for the accepted input list for every other command.

For example, the README demonstrates converting JSON input to XML output through a shell pipeline:

cat bom.json | cyclonedx-cli convert --input-format json --output-format xml > bom.xml

Here, the command reads the piped JSON and writes XML to standard output, which the shell redirects to bom.xml. Use the actual format names and options shown by your installed release’s help.

Validate JSON or XML separately from conversion

Validation and conversion serve distinct purposes. The README’s validation help lists JSON and XML input and CycloneDX specification versions 1.0 through 1.7, with 1.7 displayed as the default. These are README-documented options, not a guarantee that every release has identical behavior; confirm the available versions and default in the installed binary. Nor does support for a format in convert establish that validate accepts that format.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

The README gives this example for validation that returns a non-zero exit code on errors:

cyclonedx-cli validate --input-file sbom.xml --fail-on-errors

A non-zero exit status lets a shell script or continuous-integration job detect a failed validation. Confirm the installed release’s help for the exact option behavior before relying on it in automation.

Use stdin and stdout in scripts

According to the README, commands that accept an input-file option can read from standard input, and commands with an output-file option can write to standard output. When piping documents, specify formats if the command requires them; otherwise the CLI may not know how to interpret the stream. This makes it possible to connect BOM processing to other shell steps without creating an intermediate file for every operation.

Rank #4
Bill Payment Tracker Notebook, Monthly Bill Organizer with Annual Overview, Subscription & Auto Pay Tracker, Black Spiral Budget Book with Storage Pocket for Bills and Documents
  • STAY ON TOP OF EVERY MONTHLY BILL IN ONE PLACE – This bill tracker notebook is designed to help you organize rent, utilities, insurance, credit cards, subscriptions, and other recurring expenses in one easy system. As a practical monthly bill tracker and bill payment organizer, it helps households, busy families, couples, seniors, and anyone managing monthly bill payment keep everything clear, simple, and easy to review
  • BUILT FOR REAL HOME AND PERSONAL FINANCE USE – More than a basic bill book organizer, this bill organizer notebook includes an annual overview, subscription and auto pay tracking pages, and detailed bill record pages for day-to-day use. Whether you use it at your kitchen counter, home office desk, family command center, or during monthly budgeting sessions, this monthly bill planner helps support better bill organization and a more consistent monthly bills payment checklist routine
  • EASY-TO-USE BILL LOG PAGES THAT HELP REDUCE MISSED PAYMENTS – Each layout is made for simple tracking with space for paid status, bill name, due date, amount due, amount paid, unpaid balance, and notes. This bill payment checklist, payment tracker notebook, and monthly payment book gives you a clear way to track due dates, follow your payment plan, record your monthly payment plan, and keep important reminders in one organized place
  • A4 SIZE WITH BLACK SPIRAL BINDING AND STORAGE POCKET – Designed as a durable bill organizer book and notebook for bills, this planner features a roomy A4 format that gives you more writing space than smaller books, plus black spiral binding for easy flipping and lay-flat use. A transparent storage pocket is placed before the back cover, making it convenient to hold receipts, statements, notices, or loose documents—ideal for anyone wanting a pay bills organizer book, monthly bill payment organizer, or bills book organizer monthly setup at home
  • STURDY COVER, SMOOTH WRITING PAGES, AND A CLEAN PROFESSIONAL LOOK – Made with a 300 gsm coated paper cover and 100 GSM interior pages, this bill ledger book monthly for home is designed for regular monthly use while keeping a neat and polished appearance. It works well as a bill tracker notebook monthly bills organize solution for personal budgeting, household paperwork, and recurring bill management, making it a smart choice for anyone looking for a bills book, bill book monthly, best bill organizer book, or dependable bill payment record book
  • Use a documented input-file option with a pipe when the command supports stdin.
  • Use a documented output-file option when you want output on stdout and need to redirect or pipe it.
  • Set input and output formats explicitly where required, and check the command’s help for the installed release.
Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Support on Ko-Fi

Install the CLI and check your release’s options

The project README documents installation through Homebrew with brew install cyclonedx/cyclonedx/cyclonedx-cli and links to downloadable binaries on its releases page. The README describes the CLI as built for automation use cases. Because the README tracks the project’s main branch and command options can change, consult the help output of the binary you installed and the corresponding release notes before using exact commands in a production pipeline. The available documentation does not establish a latest release number or date.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.