Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add link to offline guide, rearrange order #1633

Merged
merged 1 commit into from
Apr 12, 2022
Merged

docs: add link to offline guide, rearrange order #1633

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,19 @@ For more details, see our [documentation](https://cve-bin-tool.readthedocs.io/en
- [CVE Binary Tool quick start / README](#cve-binary-tool-quick-start--readme)
- [Installing CVE Binary Tool](#installing-cve-binary-tool)
- [Most popular usage options](#most-popular-usage-options)
- [Using the tool offline](#using-the-tool-offline)
- [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)
- [Using the tool offline](#using-the-tool-offline)
- [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)
- [Binary checker list](#binary-checker-list)
- [Language Specific checkers](#language-specific-checkers)
- [Java](#java)
- [Javascript](#javascript)
- [Python](#python)
- [Limitations](#limitations)
- [Requirements](#requirements)
- [Feedback & Contributions](#feedback--contributions)
Expand All @@ -52,10 +55,6 @@ You can also do `pip install --user -e .` to install a local copy which is usefu

## Most popular usage options

## Using the tool offline

Specifying the `--offline` option when running a scan ensures that cve-bin-tool doesn't attempt to download the latest database files or to check for a newer version of the tool.

### Finding known vulnerabilities using the binary scanner

To run the binary scanner on a directory or file:
Expand Down Expand Up @@ -89,6 +88,12 @@ 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).

### Using the tool offline

Specifying the `--offline` option when running a scan ensures that cve-bin-tool doesn't attempt to download the latest database files or to check for a newer version of the tool.

Note that you will need to obtain a copy of the vulnerability data before the tool can run in offline mode. [The offline how-to guide contains more information on how to set up your database.](https://github.com/intel/cve-bin-tool/blob/main/doc/how_to_guides/offline.md)

## 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.
Expand Down