Skip to content

Commit

Permalink
docs: added logo to docs for consistency (#1551)
Browse files Browse the repository at this point in the history
Visible on http://jesslowe.me/osv-scanner/
Also updated README to use code blocks instead of snippets for easier
copy+paste.


![image](https://github.com/user-attachments/assets/7b2159f5-26e2-40a5-8df6-803614ad49c5)
  • Loading branch information
jess-lowe authored Feb 3, 2025
1 parent a5d0e2b commit 8aa6674
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 7 deletions.
37 changes: 30 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,10 @@ Please note: These are the instructions for the latest OSV-Scanner V2 beta. If y

### [Scanning a source directory](https://google.github.io/osv-scanner/usage)

`osv-scanner scan source -r /path/to/your/dir`
```bash
$ osv-scanner scan source -r /path/to/your/dir
```

This command will recursively scan the specified directory for any supported package files, such as `package.json`, `go.mod`, `pom.xml`, etc. and output any discovered vulnerabilities.

OSV-Scanner has the option of using call analysis to determine if a vulnerable function is actually being used in the project, resulting in fewer false positives, and actionable alerts.
Expand All @@ -74,25 +77,33 @@ See the [full documentation](https://google.github.io/osv-scanner/supported-lang

**Usage**:

`$ osv-scanner scan image my-image-name:tag`
```bash
$ osv-scanner scan image my-image-name:tag
```

![screencast of html output of container scanning](https://github.com/user-attachments/assets/8bb95366-27ec-45d1-86ed-e42890f2fb46)

### [License Scanning](https://google.github.io/osv-scanner/experimental/license-scanning/) (Experimental)

Check your dependencies' licenses using deps.dev data. For a summary:

`osv-scanner --experimental-licenses-summary path/to/repository`
```bash
osv-scanner --experimental-licenses-summary path/to/repository
```

To check against an allowed license list (SPDX format):

`osv-scanner --experimental-licenses="MIT,Apache-2.0" path/to/directory`
```bash
osv-scanner --experimental-licenses="MIT,Apache-2.0" path/to/directory
```

### [Offline Scanning](https://google.github.io/osv-scanner/experimental/offline-mode/) (Experimental)

Scan your project against a local OSV database. No network connection is required after the initial database download. The database can also be manually downloaded.

`osv-scanner --experimental-offline --experimental-download-offline-databases ./path/to/your/dir`
```bash
osv-scanner --experimental-offline --experimental-download-offline-databases ./path/to/your/dir
```

### [Guided Remediation](https://google.github.io/osv-scanner/experimental/guided-remediation/) (Experimental)

Expand All @@ -109,11 +120,23 @@ This is available as a headless CLI command, as well as an interactive mode.

#### Example (for npm)

`$ osv-scanner fix \--max-depth=3 \--min-severity=5 \--ignore-dev \--non-interactive \--strategy=in-place \-L path/to/package-lock.json`
```bash
$ osv-scanner fix \
--max-depth=3 \
--min-severity=5 \
--ignore-dev \
--non-interactive \
--strategy=in-place \
-L path/to/package-lock.json
```

#### Interactive mode (for npm)

`$ osv-scanner fix -M path/to/package.json -L path/to/package-lock.json `
```bash
$ osv-scanner fix \
-M path/to/package.json \
-L path/to/package-lock.json
```

<img src="https://google.github.io/osv-scanner/images/guided-remediation-relock-patches.png" alt="Screenshot of the interactive relock results screen with some relaxation patches selected">

Expand Down
4 changes: 4 additions & 0 deletions docs/_sass/custom/custom.scss
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,7 @@ table {
border-bottom-width: 2px;
}
}

.site-title {
padding-top: 15px !important;
}
Binary file modified docs/assets/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/logo-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/osv-full-darkmode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/osv-full-lightmode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8aa6674

Please sign in to comment.