Skip to main content

build and test OpenSSF Scorecard OpenSSF Best Practices Ruff ty Static Badge

CycloneDX Editor/Validator

This command-line tool performs various actions on CycloneDX SBOMs. It allows you to modify, merge and validate your Software Bill of Materials (SBOM).

The tool is built with automation in mind, i.e. usage within CI/CD. We try to be as scriptable as possible with various command-line flags, avoiding interactive prompts, providing multiple output options and fine-grained exit codes.

Command overview

Command Description
amend Accepts a single input file and will apply one or multiple operations to it. Each operation modifies certain aspects of the SBOM. These modifications cannot be targeted at individual components in the SBOM which sets the amend command apart from set. Its use-case is ensuring an SBOM fulfils certain requirements in an automated fashion.
build-public Creates a redacted version of an SBOM fit for publication.
init-sbom Provides a first draft of an SBOM for manual completion.
list Lists content of the SBOM.
merge Merges two or more CycloneDX documents into one.
set Sets properties on specified components to specified values. If a component in an SBOM is missing a particular property or the property is present but has a wrong value, this command can be used to modify just the affected properties without changing the rest of the SBOM.
validate Validate the SBOM against a built-in or user-provided JSON schema.
vex Apply different operations on VEX-files.

Installation and usage

This tool is published on PyPi.

For detailed installation and usage guides, please refer to our official documentation.

Contributing

See our contribution guidelines.

License

This software is made available under the GNU General Public License v3 (GPL-3.0-or-later).

Metadata

Release files for cyclonedx-editor-validator 1.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cyclonedx-editor-validator 1.2.1
File Size Uploaded Provenance Actions
cyclonedx_editor_validator-1.2.1.tar.gz 691.5 kB Without provenance Details for cyclonedx_editor_validator-1.2.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cyclonedx-editor-validator 1.2.1
File Interpreter ABI Platform Actions
cyclonedx_editor_validator-1.2.1-py3-none-any.whl Python 3 none any Details for cyclonedx_editor_validator-1.2.1-py3-none-any.whl

Total release size: 1.2 MB

Release files / cyclonedx_editor_validator-1.2.1.tar.gz

Download URL cyclonedx_editor_validator-1.2.1.tar.gz
Size 691.5 kB
Tags Source
SHA-256 checksum
How to use checksums
dcc6098d743082f6314caf221d9e3a4bab963a3f837cf4085965c6d023cec30c
BLAKE2b-256 checksum
How to use checksums
7caecaed5a760fb4ff7bb366f80ee4720ad1151b107859ae0de41e4a8ea3f741
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / cyclonedx_editor_validator-1.2.1-py3-none-any.whl

Download URL cyclonedx_editor_validator-1.2.1-py3-none-any.whl
Size 459.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7bc10a18bf33ba89e1379ab9ad9131b3da16d7e1afdad1bed47974070b0e45eb
BLAKE2b-256 checksum
How to use checksums
87e7741df8459bf7a2fbbd83086ed46ed4571ea987ecc87591407681af8aec07
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Security for cyclonedx-editor-validator 1.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.2.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page