Skip to content

Commit

Permalink
addressing comments
Browse files Browse the repository at this point in the history
Signed-off-by: Hayley Denbraver <[email protected]>
  • Loading branch information
Hayley Denbraver committed Sep 11, 2023
1 parent 0f52a98 commit 0becef9
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions docs/experimental.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ The local database file structure is in this form:
{ecosystem}/all.zip
```

Where `{local_db_dir}` is set by the `OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY` environment variable.
Where `{local_db_dir}` can be set by the `OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY` environment variable.

If the `OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY` environment variable is _not_ set, OSV-Scanner will attempt to look for the database in the following locations, in this order:

Expand All @@ -88,7 +88,12 @@ If the `OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY` environment variable is _not_ set,

The database can be [downloaded manually](./experimental.md#manual-database-download) or by using the [`--experimental-local-db` flag](./experimental.md#local-database-option).

### Offline option
The offline database flag `--experimental-offline` causes OSV-Scanner to scan your project against a previously downloaded local database. OSV-Scanner will not download or update the local database, nor will it send any project or dependency information anywhere. When a local database is not present, you will get an error message. No network connection is required when using this flag.

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

### Local database option

Expand All @@ -98,13 +103,6 @@ The local database flag `--experimental-local-db` causes OSV-Scanner to download
osv-scanner --experimental-local-db ./path/to/your/dir
```

### Offline option
The offline database flag `--experimental-offline` causes OSV-Scanner to scan your project against a previously downloaded local database. OSV-Scanner will not download or update the local database. When a local database is not present, you will get an error message. No network connection is required when using this flag.

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

### Manual database download
Instead of using the `--experimental-local-db` flag to download the database, it is possible to manually download the database.

Expand Down

0 comments on commit 0becef9

Please sign in to comment.