Skip to content

Commit a29e33a

Browse files
docs: document the --supplier flag (#28)
Documents the new `--supplier` flag on `generate` and `merge`, added to the CLI in manifest-cli. ## Changes - `ARGUMENTS.md`: `--supplier` row in the Generate and Merge flag tables, plus a "Generate with a Supplier" example. - `README.md`: `--supplier` entry in the generate flag list. The flag sets the supplier on the CycloneDX root component (`metadata.component.supplier`) and the BOM metadata (`metadata.supplier`). For SPDX output it sets the package supplier, falling back to `--group` when unset. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added documentation for a new `--supplier` option in CLI commands. * Clarified how supplier information is applied to generated and merged SBOM output. * Included an example showing how to generate an SBOM with a supplier value. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2 parents a8d140b + 80bc6f0 commit a29e33a

2 files changed

Lines changed: 15 additions & 0 deletions

File tree

ARGUMENTS.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ Generate SBOMs from local filesystems or containers.
4949
| `--output` | `-o` | string | `cyclonedx-json` | SBOM output format: `spdx-json`, `cyclonedx-json` |
5050
| `--generator-preset` | - | string | `recommended` | Set generator config preset: `recommended`, `none` |
5151
| `--generator-config` | - | string | - | Path to generator config file (if applicable) |
52+
| `--supplier` | - | string | - | Supplier (organization) name to set on the root SBOM component and BOM metadata |
5253
| `--hierarchical` | - | bool | `true` | Perform a hierarchical merge |
5354
| `--use-tmp-sbom` | - | bool | `true` | Write temporary SBOMs to OS-specific temporary folder and delete after merge |
5455
| `--keep-clone` | - | bool | `false` | Keep the local git clone once generation is completed |
@@ -212,6 +213,7 @@ Merge two or more SBOMs into a single SBOM.
212213
| `--name` | - | string | - | Name of merged SBOM document |
213214
| `--version` | - | string | - | Version of merged SBOM document |
214215
| `--group` | - | string | - | Group of merged SBOM document |
216+
| `--supplier` | - | string | - | Supplier (organization) name to set on the root SBOM component and BOM metadata. For SPDX output this sets the package supplier, falling back to `--group` when unset |
215217

216218
### Signing & Publishing
217219

@@ -349,6 +351,17 @@ manifest-cli generate ./path/to/code \
349351
--output cyclonedx-json
350352
```
351353

354+
### Generate with a Supplier
355+
356+
```bash
357+
# Set the supplier on the root component and BOM metadata
358+
manifest-cli generate ./path/to/code \
359+
--name api \
360+
--version 1.3.0 \
361+
--supplier "Manifest Cyber" \
362+
--output cyclonedx-json
363+
```
364+
352365
### Generate with Generator Passthrough
353366

354367
```bash

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,8 @@ Note: CycloneDX released v1.5 on June 25, 2023. Currently, Manifest only provide
257257

258258
`--generator-config`: set path to generator config file (if applicable)
259259

260+
`--supplier`: Supplier (organization) name to set on the root SBOM component (`metadata.component.supplier`) and the BOM metadata (`metadata.supplier`). For SPDX output this sets the package supplier, falling back to `--group` when unset.
261+
260262
`--version`: Version of the generated SBOM. Overrides any existing version info.
261263

262264
`--`: to pass through additional arguments to specific generators, use the `--` separator at the end of the command, followed by any additional arguments.

0 commit comments

Comments
 (0)