Skip to main content

build and test OpenSSF Scorecard OpenSSF Best Practices Ruff Checked with mypy 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).

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cyclonedx_editor_validator-0.34.0.tar.gz (691.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cyclonedx_editor_validator-0.34.0-py3-none-any.whl (449.0 kB view details)

Uploaded Python 3

File details

Details for the file cyclonedx_editor_validator-0.34.0.tar.gz.

File metadata

File hashes

Hashes for cyclonedx_editor_validator-0.34.0.tar.gz
Algorithm Hash digest
SHA256 aa6895c4e5ff4d853cec342134e472bf620bae74dab999c4eb9d39348372f741
MD5 aeecb277a5b5822e57663aad64042c0f
BLAKE2b-256 444a6d9b817a5e3f4ac7fc1df2131dab9dfb45a36c2cb2a9c1aa41069a2641fa

See more details on using hashes here.

File details

Details for the file cyclonedx_editor_validator-0.34.0-py3-none-any.whl.

File metadata

File hashes

Hashes for cyclonedx_editor_validator-0.34.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5397084e95f05e537a63e0bb22be6c93cc8a36143a1bfe9df0874e50b13f2ce6
MD5 fd482ee089b018edbc4ed24fdd07a3a2
BLAKE2b-256 55fcc7e362512a3432c2a9ba6430d958c127c595383df113aab0601654824904

See more details on using hashes here.

Release history Release notifications | RSS feed

0.35.0

2 files

0.34.2

2 files

0.34.1

2 files

This release

0.34.0 This release

2 files

0.33.0

2 files

0.32.2

2 files

0.32.1

2 files

0.32.0

2 files

0.31.2

2 files

0.31.1

2 files

0.31.0

2 files

0.30.12

2 files

0.30.11

2 files

0.30.10

2 files

0.30.9

2 files

0.30.8

2 files

0.30.7

2 files

0.30.6

2 files

0.30.5

2 files

0.30.4

2 files

0.30.3

2 files

0.30.2

2 files

0.30.1

2 files

0.30.0

2 files

0.29.14

2 files

0.29.13

2 files

0.29.12

2 files

0.29.11

2 files

0.29.10

2 files

0.29.9

2 files

0.29.8

2 files

0.29.7

2 files

0.29.6

2 files

0.29.5

2 files

0.29.4

2 files

0.29.3

2 files

0.29.2

2 files

0.29.1

2 files

0.29.0

2 files

0.28.1

2 files

0.28.0

2 files

0.27.8

2 files

0.27.7

2 files

0.27.6

2 files

0.27.5

2 files

0.27.4

2 files

0.27.3

2 files

0.27.2

2 files

0.27.1

2 files

0.27.0

2 files

0.26.0

2 files

0.25.5

2 files

0.25.4

2 files

0.25.3

2 files

0.25.2

2 files

0.25.1

2 files

0.25.0

2 files

0.24.0

2 files

0.23.0

2 files

0.22.1

2 files

0.22.0

2 files

0.21.0

2 files

0.20.3

2 files

0.20.2

2 files

0.20.1

2 files

0.20.0

2 files

0.19.0

2 files

0.18.2

2 files

0.18.0

2 files

0.17.0

2 files

0.16.3

2 files

0.16.2

2 files

0.16.1

2 files

0.16.0

2 files

0.15.0

2 files

0.14.4

2 files

0.14.3

2 files

0.14.2

2 files

0.14.1

2 files

0.14.0

2 files

0.13.0

2 files

0.12.1

2 files

0.12.0

2 files

0.11.2

2 files

0.11.1

2 files

0.11.0

2 files

0.10.4

2 files

0.10.3

2 files

0.10.2

2 files

0.10.1

2 files

0.10.0

2 files

0.9.4

2 files

0.9.3

2 files

0.9.2

2 files

0.9.1

2 files

0.9.0

2 files

0.8.1

2 files

0.8.0

2 files

0.7.3

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.1

2 files

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