From a124bdecd019b299363cb749d5de7d300a99de88 Mon Sep 17 00:00:00 2001 From: DangerChamp <77676230+DangerChamp@users.noreply.github.com> Date: Wed, 12 Jan 2022 02:02:01 +0000 Subject: [PATCH] doc: Gave output types its own subheading in README.md (Fixes #1506) (#1516) * Fixes #1506 --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index a3d9294fd8..b7f4d3d040 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,7 @@ For more details, see our [documentation](https://cve-bin-tool.readthedocs.io/en - [Finding known vulnerabilities using the binary scanner](#finding-known-vulnerabilities-using-the-binary-scanner) - [Finding known vulnerabilities in a list of components](#finding-known-vulnerabilities-in-a-list-of-components) - [Scanning an SBOM file for known vulnerabilities](#scanning-an-sbom-file-for-known-vulnerabilities) + - [Output Options](#output-options) - [Full option list](#full-option-list) - [Configuration](#configuration) - [Using CVE Binary Tool in Github Actions](#using-cve-binary-tool-in-github-actions) @@ -78,6 +79,8 @@ cve-bin-tool --sbom --sbom-file Valid SBOM types are [SPDX](https://spdx.dev/specifications/), [CycloneDX](https://cyclonedx.org/specification/overview/), and [SWID](https://csrc.nist.gov/projects/software-identification-swid/guidelines). +## Output Options + The CVE Binary Tool provides console-based output by default. If you wish to provide another format, you can specify this and a filename on the command line using `--format`. The valid formats are CSV, JSON, console, HTML and PDF. The output filename can be specified using the `--output-file` flag. ## Full option list