# `osv`

Package for connecting to the [`osv` database](https://osv.dev/).

This utilizes the [`osv-scanner`](https://github.com/google/osv-scanner) library written by Google to examine the contents of the Open Source Vulnerability database.

All of the `osv` [infrastructure](https://github.com/google/osv.dev) and [data](https://console.cloud.google.com/storage/browser/osv-vulnerabilities) is open source.

## Usage

The main export of the package is `getVulnerabilities`:

```ts
import { type Vulnerabilities } from "src/types";
import { Osv } from "src/connectors/osv";

const vulnerabilities: Vulnerabilities[] = await new Osv().getVulnerabilities();
```

## Additional Features

Other features of OSV include [guided remediation](https://google.github.io/osv-scanner/experimental/guided-remediation/), which is pretty cool.