Skip to content

Commit 9e32cd7

Browse files
authored
docs: add link to offline guide, rearrange order (#1633)
1 parent a0bbdee commit 9e32cd7

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,19 @@ For more details, see our [documentation](https://cve-bin-tool.readthedocs.io/en
2424
- [CVE Binary Tool quick start / README](#cve-binary-tool-quick-start--readme)
2525
- [Installing CVE Binary Tool](#installing-cve-binary-tool)
2626
- [Most popular usage options](#most-popular-usage-options)
27-
- [Using the tool offline](#using-the-tool-offline)
2827
- [Finding known vulnerabilities using the binary scanner](#finding-known-vulnerabilities-using-the-binary-scanner)
2928
- [Finding known vulnerabilities in a list of components](#finding-known-vulnerabilities-in-a-list-of-components)
3029
- [Scanning an SBOM file for known vulnerabilities](#scanning-an-sbom-file-for-known-vulnerabilities)
30+
- [Using the tool offline](#using-the-tool-offline)
3131
- [Output Options](#output-options)
3232
- [Full option list](#full-option-list)
3333
- [Configuration](#configuration)
3434
- [Using CVE Binary Tool in GitHub Actions](#using-cve-binary-tool-in-github-actions)
3535
- [Binary checker list](#binary-checker-list)
3636
- [Language Specific checkers](#language-specific-checkers)
37+
- [Java](#java)
38+
- [Javascript](#javascript)
39+
- [Python](#python)
3740
- [Limitations](#limitations)
3841
- [Requirements](#requirements)
3942
- [Feedback & Contributions](#feedback--contributions)
@@ -52,10 +55,6 @@ You can also do `pip install --user -e .` to install a local copy which is usefu
5255

5356
## Most popular usage options
5457

55-
## Using the tool offline
56-
57-
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.
58-
5958
### Finding known vulnerabilities using the binary scanner
6059

6160
To run the binary scanner on a directory or file:
@@ -89,6 +88,12 @@ cve-bin-tool --sbom <sbom_filetype> --sbom-file <sbom_filename>
8988
Valid SBOM types are [SPDX](https://spdx.dev/specifications/),
9089
[CycloneDX](https://cyclonedx.org/specification/overview/), and [SWID](https://csrc.nist.gov/projects/software-identification-swid/guidelines).
9190

91+
### Using the tool offline
92+
93+
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.
94+
95+
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)
96+
9297
## Output Options
9398

9499
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.

0 commit comments

Comments
 (0)