Skip to content

Commit

Permalink
doc: Moved --offline up to "Most popular usage options" (#1514)
Browse files Browse the repository at this point in the history
* fixes #1505
Co-authored-by: Terri Oda <terri.oda@intel.com>
Co-authored-by: Bread Genie <63963181+BreadGenie@users.noreply.github.com>
  • Loading branch information
DangerChamp committed Jan 13, 2022
1 parent 277f3b9 commit 7464205
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ 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)
Expand All @@ -50,6 +51,10 @@ 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 @@ -173,8 +178,6 @@ in the terminal and provide it as an input by running `cve-bin-tool -L pkg-list`
You can use `--config` option to provide configuration file for the tool. You can still override options specified in config file with command line arguments. See our sample config files in the
[test/config](https://github.com/intel/cve-bin-tool/blob/main/test/config/)

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.

## Using CVE Binary Tool in Github Actions

If you want to integrate cve-bin-tool as a part of your github action pipeline.
Expand Down

0 comments on commit 7464205

Please sign in to comment.