cyclonedx/cyclonedx-cliCLI para gerar, analisar, mesclar, comparar, validar, assinar e converter SBOMs CycloneDX nos formatos JSON, XML, Protobuf, CSV e SPDX.
______ __ ____ _ __ ________ ____
/ ____/_ _______/ /___ ____ ___ / __ \ |/ / / ____/ / / _/
/ / / / / / ___/ / __ \/ __ \/ _ \/ / / / / / / / / / /
/ /___/ /_/ / /__/ / /_/ / / / / __/ /_/ / | / /___/ /____/ /
\____/\__, /\___/_/\____/_/ /_/\___/_____/_/|_| \____/_____/___/
/____/
Usage:
cyclonedx [command] [options]
Options:
--version Show version information
-?, -h, --help Show help and usage information
Commands:
add Add information to a BOM (currently supports files)
analyze Analyze a BOM file
convert Convert between different BOM formats
diff <from-file> <to-file> Generate a BOM diff
keygen Generates an RSA public/private key pair for BOM signing
merge Merge two or more BOMs
sign Sign a BOM or file
validate Validate a BOM
verify Verify signatures in a BOM
A ferramenta CLI CycloneDX atualmente suporta análise, modificação, geração de diff, mesclagem, conversão de formato, assinatura e verificação de BOMs.
A conversão é suportada entre CycloneDX XML, JSON, Protobuf, CSV e SPDX JSON v2.3.
Os binários podem ser baixados da página de releases.
Nota: A ferramenta CLI CycloneDX foi desenvolvida para casos de uso de automação. Quaisquer comandos que tenham a opção --input-file também suportam entrada via stdin. Da mesma forma, quaisquer comandos que tenham a opção --output-file suportam saída para stdout. No entanto, você precisará fornecer os formatos de entrada/saída.
Por exemplo:
cat bom.json | cyclonedx-cli convert --input-format json --output-format xml > bom.xml
files
Add files to a BOM
Usage:
cyclonedx add files [options]
Options:
--input-file <input-file> Input BOM filename.
--no-input Use this option to indicate that there is no input BOM.
--output-file <output-file> Output BOM filename, will write to stdout if no value provided.
--input-format <autodetect|json|protobuf|xml> Specify input file format.
--output-format <autodetect|json|protobuf|xml> Specify output file format.
--base-path <base-path> Base path for directory to process (defaults to current working directory if omitted).
--include <include> Apache Ant style path and file patterns to specify what to include (defaults to all files, separate patterns with a space).
--exclude <exclude> Apache Ant style path and file patterns to specify what to exclude (defaults to none, separate patterns with a space).
Gerando um BOM de código-fonte, excluindo o diretório do repositório Git:
cyclonedx-cli add files --no-input --output-format json --exclude /.git/**
Adicionando arquivos de saída de build, do diretório bin, a um BOM existente:
cyclonedx-cli add files --input-file bom.json --output-format json --base-path bin
analyze
Analyze a BOM file
Usage:
cyclonedx analyze [options]
Options:
--input-file <input-file> Input BOM filename, will read from stdin if no value provided.
--input-format <autodetect|json|protobuf|xml> Specify input file format.
--output-format <json|text> Specify output format (defaults to text).
--multiple-component-versions Report components that have multiple versions in use.
Relatando componentes que são incluídos várias vezes com versões diferentes:
cyclonedx-cli analyze --input-file sbom.xml --multiple-component-versions
convert
Convert between different BOM formats
Usage:
cyclonedx convert [options]
Options:
--input-file <input-file> Input BOM filename, will read from stdin if no value provided.
--output-file <output-file> Output BOM filename, will write to stdout if no value provided.
--input-format <autodetect|csv|json|protobuf|spdxjson|xml> Specify input file format.
--output-format <autodetect|csv|json|protobuf|spdxjson|xml> Specify output file format.
--output-version <v1_0|v1_1|v1_2|v1_3|v1_4|v1_5|v1_6|v1_7> Specify output BOM specification version. (ignored for CSV and SPDX formats)
Convertendo do formato XML para JSON:
cyclonedx-cli convert --input-file sbom.xml --output-file sbom.json
Convertendo do formato XML para JSON e enviando a saída via pipe para outras ferramentas:
cyclonedx-cli convert --input-file sbom.xml --output-format json | grep "somthing"
O formato CSV é uma representação limitada da lista de componentes em um BOM.
A intenção é fornecer uma maneira simples para os usuários produzirem e consumirem BOMs para casos de uso simples. Incluindo casos de uso simples de migração de dados.
Os únicos campos obrigatórios são os campos name e version do componente. Os demais podem ser deixados em branco ou as colunas omitidas.
A conversão entre os formatos SPDX e CycloneDX pode resultar na perda de algumas informações. A funcionalidade de conversão é fornecida pela biblioteca CycloneDX.Spdx.Interop, que faz parte do projeto da biblioteca CycloneDX .NET.
Para mais detalhes sobre quais informações são perdidas, consulte a página do projeto CycloneDX .NET Library.
diff
Generate a BOM diff
Usage:
cyclonedx diff <from-file> <to-file> [options]
Arguments:
<from-file> From BOM filename.
<to-file> To BOM filename.
Options:
--from-format <autodetect|json|protobuf|xml> Specify from file format.
--to-format <autodetect|json|protobuf|xml> Specify to file format.
--output-format <json|text> Specify output format (defaults to text).
--component-versions Report component versions that have been added, removed or modified.
Relatando componentes com alterações de versão:
cyclonedx-cli diff sbom-from.xml sbom-to.xml --component-versions
keygen
Generates an RSA public/private key pair for BOM signing
Usage:
cyclonedx keygen [options]
Options:
--private-key-file <private-key-file> Filename for generated private key file (defaults to "private.key")
--public-key-file <public-key-file> Filename for generated public key file (defaults to "public.key")
merge
Merge two or more BOMs
Usage:
cyclonedx merge [options]