Skip to content

Commit

Permalink
Update README.md to include strict SBOM validation flag
Browse files Browse the repository at this point in the history
  • Loading branch information
djschleen authored Oct 9, 2024
1 parent abd1ccf commit f96b1fd
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| ---------------------- | ----------------------------------------------------------------------------------------------------------- |
| `<SBOM>` | The SBOM (Software Bill of Materials) to process. This argument is required. |
| `--ratelimit <MS>` | Optional time in milliseconds to pause before making requests to https://trustypkg.dev. Defaults to 500 ms. |
| `--output_file <FILE>` | Optional file name to write JSON output to. If not provided, output will be printed to the console. |
| Argument | Description |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `<SBOM>` | The SBOM (Software Bill of Materials) to process. This argument is required. |
| `--ratelimit <MS>` | Optional time in milliseconds to pause before making requests to https://trustypkg.dev. Defaults to 500 ms. |
| `--output_file <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

Expand All @@ -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 -

Expand All @@ -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

Expand Down

0 comments on commit f96b1fd

Please sign in to comment.