# @renovatebot/osv-offline 中文文档

规范地址：https://npmcn.com/package/%40renovatebot/osv-offline/

版本：4\.5\.7
npm 元数据更新时间：2026-11-02T07:21:53.900Z
中文译文更新时间：2026-11-02T07:59:55.834Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40renovatebot/osv-offline
原文对照：https://npmcn.com/package/%40renovatebot/osv-offline/?lang=original
源码仓库：https://github.com/renovatebot/osv-offline

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：27.8 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=24\.11\.0
- 运行依赖：6 个
- 首次发布：2022-09-14T07:38:10.356Z
- 最新版本发布：2026-11-02T07:21:53.452Z
- 已发布版本数：124（近 12 个月 47 个）

## 中文简介

暂无中文简介

## 安装

```sh
npm install @renovatebot/osv-offline
```

也可以使用：`pnpm add @renovatebot/osv-offline`、`yarn add @renovatebot/osv-offline`、`bun add @renovatebot/osv-offline`

## README

# osv-offline

[![Package version](https://img.shields.io/npm/v/@renovatebot/osv-offline?style=for-the-badge)](https://www.npmjs.com/package/@renovatebot/osv-offline) [![Build status](https://img.shields.io/github/actions/workflow/status/renovatebot/osv-offline/build.yml?branch=main&style=for-the-badge)](https://github.com/renovatebot/osv-offline/actions/workflows/build.yml) [![MIT license](https://img.shields.io/badge/license-MIT-blue?style=for-the-badge)](https://npmcn.com/package/%40renovatebot/osv-offline/LICENSE)

## 环境变量

| 名字 | 描述 | 默认的 |
| --- | --- | --- |
| `OSV_OFFLINE_ROOT_DIR` | 下载数据库的目录 | `<tmpdir>/osv-offline` |
| `OSV_OFFLINE_DATABASE_FORMAT` | `zip` 将所有数据库下载为一个zip文件； `split` 下载每个生态系统的第一个查询，并再次只有当它改变 | `zip` |
| `OSV_OFFLINE_DATABASE_URL` | 数据库zip文件的URL | `https://github.com/renovatebot/osv-offline/releases/latest/download/osv-offline.zip` |
| `OSV_OFFLINE_DATABASE_INDEX_URL` | 的网址 `index.json` 分割格式的 | `https://renovatebot.github.io/osv-offline/v2/index.json` |
| `OSV_OFFLINE_DISABLE_DOWNLOAD` | 设置为 `true` 中使用数据库 `OSV_OFFLINE_ROOT_DIR` 不需要下载 | \- |
| `OSV_OFFLINE_MAX_AGE` | 下载的数据库在再次下载之前可能有多长时间 [`ms`](https://github.com/vercel/ms) 持续时间如 `30m`， `4h` 或者 `7d` | `1d` |

### 分裂格式

与 `OSV_OFFLINE_DATABASE_FORMAT=split`的最新数据库更新版本(`https://github.com/renovatebot/osv-offline/releases/download/1-<yyyyMMddHHmmss>/`)，如索引所列 `https://renovatebot.github.io/osv-offline/`． 当传出流量受到限制时，允许 `github.com`， `release-assets.githubusercontent.com` （下载重定向到）和 `renovatebot.github.io`.

要镜像分割格式，请复制 `index.json` 没有了 `baseUrl` 它将文件列在一个目录中，然后设置 `OSV_OFFLINE_DATABASE_INDEX_URL` 到镜像上 `index.json`． 然后相对于索引解析文件。

### 没有互联网接入

这些变量也适用于 [翻新的 `osvVulnerabilityAlerts`](https://docs.renovatebot.com/configuration-options/#osvvulnerabilityalerts)，它使用这个包。

`osv-offline` 一旦数据库比 `OSV_OFFLINE_MAX_AGE`，默认一天。集 `OSV_OFFLINE_DISABLE_DOWNLOAD=true` 把它关掉。

使用内部镜像时，使用copy `osv-offline.zip` 从 [最新版本](https://github.com/renovatebot/osv-offline/releases/latest) 到内部web服务器并设置 `OSV_OFFLINE_DATABASE_URL` 去复印。之后再从那里下载数据库 `OSV_OFFLINE_MAX_AGE`.

没有任何下载，自己提取数据库并禁用下载：

```sh
export OSV_OFFLINE_ROOT_DIR=/var/lib/osv-offline
export OSV_OFFLINE_DISABLE_DOWNLOAD=true
unzip -o osv-offline.zip -d "$OSV_OFFLINE_ROOT_DIR"
```

-   `OSV_OFFLINE_ROOT_DIR` 需要一个 `<ecosystem>.nedb` 每个生态系统，例如： `npm.nedb`;这个 `<ecosystem>.idx.json` 它旁边是可选的，但推荐使用，因为它使打开数据库的速度提高了大约四倍
-   要在Renovate运行时进行更新，请将较新的zip解压缩到同一文件系统上的临时目录中，并将这些文件移动到 `OSV_OFFLINE_ROOT_DIR`, `.idx.json` 之前的文件 `.nedb` 文件，因此在写入数据库时不会读取数据库

## 日志记录

包将日志记录到设置为 `configure({ logger })` 的 [`@containerbase/base`](https://www.npmjs.com/package/@containerbase/base),如。pino或Renovate记录器。 他们的信息是这样开始的 `OSV:`,如。翻新的 `logLevelRemap`. 如果没有，他们就会登录 [`debug`](https://github.com/debug-js/debug) (名称空间 `osv-offline:*`）。

## 许可证

这个包被授权 [MIT许可证](https://opensource.org/licenses/MIT).

漏洞来自以下上游数据源和license：

-   [GitHub咨询数据库](https://github.com/github/advisory-database) （[CC-BY 4.0](https://github.com/github/advisory-database/blob/main/LICENSE.md)）
-   [PyPI咨询数据库](https://github.com/pypa/advisory-database) （[CC-BY 4.0](https://github.com/pypa/advisory-database/blob/main/LICENSE)）
-   [Go漏洞数据库](https://github.com/golang/vulndb) （[CC-BY 4.0](https://github.com/golang/vulndb#license)）
-   [防锈咨询数据库](https://github.com/RustSec/advisory-db) （[CC0 1.0](https://github.com/rustsec/advisory-db/blob/main/LICENSE.txt)）
-   [全球安全数据库](https://github.com/cloudsecurityalliance/gsd-database) （[CC0 1.0](https://github.com/cloudsecurityalliance/gsd-database/blob/main/LICENSE)）
-   [OSS-Fuzz](https://github.com/google/oss-fuzz-vulns) （[CC-BY 4.0](https://github.com/google/oss-fuzz-vulns/blob/main/LICENSE)）

## 常见问题

### 如何安装 @renovatebot/osv-offline？

在项目目录运行 npm install @renovatebot/osv-offline，或使用 pnpm add / yarn add / bun add。

### @renovatebot/osv-offline 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/renovatebot\_\_osv-offline 是否存在。

### @renovatebot/osv-offline 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @renovatebot/osv-offline 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24\.11\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @renovatebot/osv-offline 可以商用吗？

@renovatebot/osv-offline 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @renovatebot/osv-offline 还在维护吗？

最新版本 4\.5\.7 发布于 2026/11/02（1 天前）；至今共发布 124 个版本，其中过去 12 个月发布了 47 个；首次发布于 2022/09/14。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。