# @wrenautomation/read 中文文档

规范地址：https://npmcn.com/package/%40wrenautomation/read/

版本：0\.30\.6
npm 元数据更新时间：2026-11-02T22:15:28.728Z
中文译文更新时间：2026-11-02T22:27:06.466Z
软件包许可：PolyForm-Strict-1\.0\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40wrenautomation/read
原文对照：https://npmcn.com/package/%40wrenautomation/read/?lang=original
项目主页：https://github.com/wrenautomation/engine#readme
源码仓库：https://github.com/wrenautomation/engine

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

- 包体积（解压后）：197 kB，72 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：6 个
- 首次发布：2026-10-29T21:01:30.814Z
- 最新版本发布：2026-11-02T22:15:28.349Z
- 已发布版本数：9（近 12 个月 9 个）

## 中文简介

网页和文件输入，文本输出。礼貌的HTTP抓取机器人和抓取梯子到浏览器；HTML和PDF以文字为主，一页以标题、文字和链接为主；来自URL或文件的视频或播客（字幕，ffmpeg和视觉模型，音频标记，等等）

## 安装

```sh
npm install @wrenautomation/read
```

也可以使用：`pnpm add @wrenautomation/read`、`yarn add @wrenautomation/read`、`bun add @wrenautomation/read`

## README

# 读

网页和文件输入，文本输出。没有数据库，没有帐户，没有业务规则：一个库 获取和读取。在0.29.0之前，这是falcon（文件、标记、媒体）以及fetch和video 织布者的一半；上面的搜索引擎是 [`@wrenautomation/birdwatch`](https://github.com/wrenautomation/engine/tree/main/packages/birdwatch)， 谁的 `birdwatch` CLI携带这些读取器(`fetch`， `read`， `list`， `text`， `page`， `watch`）。

| 进口 | 做 |
| --- | --- |
| `@wrenautomation/read/fetch` | `PoliteFetcher` （每个主机一次一个请求，User-Agent中的一个联系人，重试429和5xx，一个字节上限）， `robots` 在警告模式下， `fetchLadder` (通过一个 `LadderClient`: autobrowse `web GET /fetch`） |
| `@wrenautomation/read/text` | `htmlText`， `pdfText`， `decodeHtml`， `decodeEntities`； `readPage` （HTML到标题，文本，链接，邮件，电话） |
| `@wrenautomation/read/video` | `watchFile` 一个视频文件：ffmpeg剪辑和帧，一个耳朵的演讲(`cohereSpeech`)，对框架的眼睛(`cohereEye`)，以及给定时视频模型读取整个文件(`geminiVideo`，或者 `geminiReader` 没有密钥检查（对于持有密钥的代理）；标签。通过URL： `readYoutube` （由yt-dlp提供的字幕和章节，以及视频模型在剪辑中读取的屏幕）， `readYoutubeByUrl` （仅视频模型，无需下载）， `readVideo` (还有其他视频吗：y -dlp `watchFile`)， `readAudio` (那么，一个播客的音频URL `hearAudio`)， `watch` 通过一个URL或一个文件 `flatPlaylist` （个人资料、频道或搜索的内容）， `download`。每个读者都会返回1 `VideoRead` 形状 |
| `@wrenautomation/read/study` | 一个研究的综合阅读器：引门(`pageQuoted`， `numbersQuoted`)，每页显示的段落，引用声明的草稿，降价报告 |

一切都是你传递的内容的函数：URL、字节、文本、文件路径、模型、工具。什么 搜索，存储，安排或知道客户属于呼叫者。每个模型呼叫 通过 `@wrenautomation/models`. `watch` URL上的阅读器需要ffmpeg和yt-dlp。

```ts
import { PoliteFetcher, userAgent } from "@wrenautomation/read/fetch";
import { readPage } from "@wrenautomation/read/text";

const fetcher = new PoliteFetcher(userAgent("you@example.com"));
const res = await fetcher.get(url);
const page = readPage(res.text, res.url);
```

## 开发

```sh
pnpm install
pnpm lint && pnpm typecheck && pnpm test
```

一、 `v*` 标签向NPM发布(`.github/workflows/release.yml`可信发布：不存储令牌)。

许可证：PolyForm Strict 1.0.0 (`LICENSE.md`）。

## 常见问题

### @wrenautomation/read 是什么？

网页和文件输入，文本输出。礼貌的HTTP抓取机器人和抓取梯子到浏览器；HTML和PDF以文字为主，一页以标题、文字和链接为主；来自URL或文件的视频或播客（字幕，ffmpeg和视觉模型，音频标记，等等）

### 如何安装 @wrenautomation/read？

在项目目录运行 npm install @wrenautomation/read，或使用 pnpm add / yarn add / bun add。

### @wrenautomation/read 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @wrenautomation/read 支持 ESM 还是 CommonJS？

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

### @wrenautomation/read 需要什么版本的 Node\.js？

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

### @wrenautomation/read 可以商用吗？

@wrenautomation/read 使用 PolyForm-Strict-1\.0\.0 许可。声明的许可为 PolyForm-Strict-1\.0\.0，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @wrenautomation/read 还在维护吗？

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