Skip to content

Commit

Permalink
doc: Gave output types its own subheading in README.md (Fixes #1506) (#…
Browse files Browse the repository at this point in the history
…1516)

* Fixes #1506
  • Loading branch information
DangerChamp authored Jan 12, 2022
1 parent 1c8e880 commit a124bde
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -78,6 +79,8 @@ cve-bin-tool --sbom <sbom_filetype> --sbom-file <sbom_filename>
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
Expand Down

0 comments on commit a124bde

Please sign in to comment.