An open API service indexing awesome lists of open source software.

https://github.com/zakodium/sbom-tools

Tools to analyse CycloneDX SBOM files
https://github.com/zakodium/sbom-tools

Last synced: 5 months ago
JSON representation

Tools to analyse CycloneDX SBOM files

Awesome Lists containing this project

README

          

# @zakodium/sbom-tools

[![NPM version](https://img.shields.io/npm/v/@zakodium/sbom-tools.svg)](https://www.npmjs.com/package/@zakodium/sbom-tools)
[![npm download](https://img.shields.io/npm/dm/@zakodium/sbom-tools.svg)](https://www.npmjs.com/package/@zakodium/sbom-tools)
[![test coverage](https://img.shields.io/codecov/c/github/zakodium/sbom-tools.svg)](https://codecov.io/gh/zakodium/sbom-tools)
[![license](https://img.shields.io/npm/l/@zakodium/sbom-tools.svg)](https://github.com/zakodium/sbom-tools/blob/main/LICENSE)

Tools to analyse CycloneDX SBOM files.

## Installation

```console
npm install @zakodium/sbom-tools
```

## Usage

### Generate SBOM file

The tools expect a SBOM file in CycloneDX JSON format, version 1.6.

#### npm

See .

A compatible SBOM can be generated with:

```shell
npx --package @cyclonedx/cyclonedx-npm cyclonedx-npm --omit=dev --spec-version=1.6 --gather-license-texts --output-reproducible --output-file=sbom.json
```

#### Yarn

See

A compatible SBOM can be generated with:

```shell
yarn dlx -q @cyclonedx/yarn-plugin-cyclonedx --production --spec-version=1.6 --gather-license-texts --output-reproducible --output-file=sbom.json
```

## License

[MIT](./LICENSE)