From f96b1fd83a74fc935251342543910559bc0462a4 Mon Sep 17 00:00:00 2001 From: DJ Schleen Date: Wed, 9 Oct 2024 02:12:37 +0000 Subject: [PATCH] Update README.md to include strict SBOM validation flag --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 12f1403..dabb199 100644 --- a/README.md +++ b/README.md @@ -59,16 +59,16 @@ Sources: Binaries for Mac, Linux, and Windows Platforms are available from the [Releases](https://github.com/devops-kung-fu/trustier/releases) section of this repsitory. Download, unpack, and use! -__NOTE:__ The application has not been tested on all platforms and architectures. If you experience any issues, please report them [here]( -https://github.com/devops-kung-fu/trustier/issues) +**NOTE:** The application has not been tested on all platforms and architectures. If you experience any issues, please report them [here](https://github.com/devops-kung-fu/trustier/issues) ## Application Arguments -| Argument | Description | -| ---------------------- | ----------------------------------------------------------------------------------------------------------- | -| `` | The SBOM (Software Bill of Materials) to process. This argument is required. | -| `--ratelimit ` | Optional time in milliseconds to pause before making requests to https://trustypkg.dev. Defaults to 500 ms. | -| `--output_file ` | Optional file name to write JSON output to. If not provided, output will be printed to the console. | +| Argument | Description | +| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `` | The SBOM (Software Bill of Materials) to process. This argument is required. | +| `--ratelimit ` | Optional time in milliseconds to pause before making requests to https://trustypkg.dev. Defaults to 500 ms. | +| `--output_file ` | Optional file name to write JSON output to. If not provided, output will be printed to the console. | +| `--strict` | If set, will perform a strict SBOM validation, otherwise `trustier` will attempt to process the SBOM. Optional and defaults to false | ## Example Usage @@ -82,6 +82,9 @@ trustier sbom_file.json --ratelimit 1000 # Optional output_file argument trustier sbom_file.json --output_file output.json +# Perform strict SBOM validation +trustier sbom_file.json --strict --output_file output.json + # Takes an SBOM from STDIN and outputs JSON without any console decoration cat sbom_file.json | trustier - @@ -97,7 +100,7 @@ During testing, we found there were some required fields needed in the SBOM in o - `purl` - `type` -__NOTE:__ `trustier` does not support SPDX formatted SBOMS at this time. +**NOTE:** `trustier` does not support SPDX formatted SBOMS at this time. ## Credits