osv-scanner: add page (#9831)

* osv-scanner: add page

The Open Source Vulnerability (OSV) Database is a distributed vulnerability database for open source ecosystems.

* Apply suggestions from code review

Co-authored-by: Jack Lin <blueskyson1401@gmail.com>

* osv-scanner: fix syntax

---------

Co-authored-by: Jack Lin <blueskyson1401@gmail.com>
pull/3/head
Fernando Fontana 2023-02-07 00:00:18 -03:00 committed by GitHub
parent 333d66b562
commit cbac3166ae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 0 deletions

View File

@ -0,0 +1,28 @@
# osv-scanner
> Scan various mediums for dependencies and matches them against the OSV database.
> More information: <https://osv.dev/about>.
- Scan a docker image:
`osv-scanner -D {{docker_image_name}}`
- Scan a package lockfile:
`osv-scanner -L {{path/to/lockfile}}`
- Scan an SBOM file:
`osv-scanner -S {{path/to/sbom_file}}`
- Scan multiple directories recursively:
`osv-scanner -r {{directory1 directory2 ...}}`
- Skip scanning git repositories:
`osv-scanner --skip-git {{-r|-D}} {{target}}`
- Output result in JSON format:
`osv-scanner --json {{-D|-L|-S|-r}} {{target}}`