# @bitefoundry/retrieviewer 中文文档

规范地址：https://npmcn.com/package/%40bitefoundry/retrieviewer/

版本：0\.0\.27
npm 元数据更新时间：2026-10-27T16:22:49.434Z
中文译文更新时间：2026-11-08T04:29:11.570Z
软件包许可：SEE LICENSE IN LICENSE

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

原始 npm 页面：https://www.npmjs.com/package/%40bitefoundry/retrieviewer
原文对照：https://npmcn.com/package/%40bitefoundry/retrieviewer/?lang=original
项目主页：https://bitefoundry.github.io/retrieviewer/
源码仓库：https://github.com/BiteFoundry/retrieviewer

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

- 包体积（解压后）：23.5 MB，143 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- 首次发布：2026-10-23T01:28:01.700Z
- 最新版本发布：2026-10-27T16:22:49.209Z
- 近 30 天下载量：5388（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：28（近 12 个月 28 个）

## 中文简介

用于Windows和Linux X11的绒毛盲文桌面宠物,有实验性的macOS支持和可嵌入的TUI引擎.

## 安装

```sh
npm install @bitefoundry/retrieviewer
```

也可以使用：`pnpm add @bitefoundry/retrieviewer`、`yarn add @bitefoundry/retrieviewer`、`bun add @bitefoundry/retrieviewer`

## README

[![Retrieviewer — a fluffy retriever drawn with tiny monochrome Braille dots](https://raw.githubusercontent.com/BiteFoundry/retrieviewer/main/docs/assets/preview.png)](https://bitefoundry.github.io/retrieviewer/)

# 检索查看器

给你的屏幕带个小伴.

[见见取回器](https://bitefoundry.github.io/retrieviewer/) • 妇女 [한국어](https://npmcn.com/package/%40bitefoundry/retrieviewer/README.ko.md) • 妇女 [无](https://www.npmjs.com/package/@bitefoundry/retrieviewer) • 妇女 [反馈](https://github.com/BiteFoundry/retrieviewer/issues)

一个松动自发的盲文艺术检索器 挂在应用窗口上方. 它会走来走去 跑去跑去 飞来跑去 有时它会追逐蝴蝶. 掷出一球,提供取乐或打拖. 回到你的东西.

由 [咬伤基金会](https://github.com/BiteFoundry)无 API 模型、账户或 运行时需要遥测.

## 带一个回家

安装 **在显示应用程序的计算机上**在终点站 需要节点.js; [首先安装节点/npm](https://npmcn.com/package/%40bitefoundry/retrieviewer/PREREQUISITES.md) 如果你没有的话.

1.  安装( 或更新) :
    
    ```sh
    npm install -g @bitefoundry/retrieviewer@latest
    ```
    
2.  运行,然后在取取窗口时选择一个应用程序 :
    
    ```sh
    retrieviewer desktop
    ```
    

下次,快点跑 `retrieviewer desktop`这是一个单独的透明, 点击本地覆盖- 不是补丁的应用程序、 shell 包装或注入的 MCP 部件。 它跟随一个完整的应用窗口,而不是一个标签,当窗口是时隐藏 非活动或最小化。 没有安装自动启动条目 .

选择发射时的点颜色 : `retrieviewer desktop --ink gold`,或 `retrieviewer desktop --ink dark` 为浅色背景。 默认 : `cream`。 。 。 . 先别出跑伴. 颜色重用同样的艺术品.

选择返回方式 `--return-style auto|brake|trot|run-trot`。 。 。 . `auto` 混合原有的制动返回,一个脚踏车和运行时的脚踏车,没有 相邻重复。 譬如说, `retrieviewer desktop --return-style brake` 保留 原始回归。 退出并重新启动更改桌面选择; 已存在 伴侣不会为您重新启动 。 嵌入器可以使用 `createPet({returnStyle:'auto'})` 财务报告和审定财务报表 `pet.setReturnStyle('brake')`; 更改适用于下个抛出,而不是中缩写.

> **Cursor / VS 代码远程 SSH :** 运行您中的这些命令 **当地** 电脑 终端,不是远程服务器的终端。 小狗属于窗户的地方 显示。 服务器 `DISPLAY=:1` 指该服务器的 X11 显示,该显示 您可能正在通过 VNC 查看;它不是自动的本地光标窗口.

尝试一次未找到 npx / 命令/ 节点

在安装了节点/npm后,在没有全局安装的情况下进行尝试 :

```sh
npx --yes --package @bitefoundry/retrieviewer@latest retrieviewer desktop
```

`npx` 已经 **没有** 永久添加 `retrieviewer` 到路径。 使用全局安装 用于未来的短命令。 如果还写着没有找到命令,请看 [流行、 csh/tcsh 和 Windows 的 PATH 修正](https://npmcn.com/package/%40bitefoundry/retrieviewer/PREREQUISITES.md#command-not-found)。 。 。 . 不使用 `sudo npm install -g` 做个工作.

## 它能活到哪里去吗

| 桌面 | 状况/所需经费 |
| --- | --- |
| Windows 10/11 x64 (英语) | 现场测试 节点20+; 捆绑的本地引擎用于基本模式. 可选观看使用.NET兼容性帮助. |
| Linux X11 函数 | AlmaLinux 8 / GLIBC 2.28 / Python 3.6.8 / Node 22.23.4 在一个被隔离的复合X11桌面上测试. 需要系统 Python 3.6+, X11/Xrender/Xext 和一个堆肥. |
| 马科斯 | **实验; 还没有Mac 运行时间验证 .** 使用内置的osascript/AppKit. |
| 原生 Wayland / 无头 SSH | 不支持桌面覆盖 。 没有安装会话/空闲工作. |

Linux 目前倾向于降低负载: 16px 单元格 / 15fps 相对于 Windows 默认值 8px细胞 / 30fps,所以其点外观为收缩. Q5的艺术品是相同的. 0.021 npm的柏油球为21.42 MB (20.43 MiB). 见 [内存测量](https://npmcn.com/package/%40bitefoundry/retrieviewer/PUPPY-MEMORY.md) 财务报告和审定财务报表 [平台细节和核查边界](https://npmcn.com/package/%40bitefoundry/retrieviewer/DESKTOP-PLATFORMS.md)。 。 。 .

## 也容易离开

退出控件,或运行 `retrieviewer desktop-stop`。 。 。 . 要移除同伴自己的缓存和软件包:

```sh
retrieviewer desktop-remove --yes
npm uninstall -g @bitefoundry/retrieviewer
```

桌面伴侣不编辑代理证书、 app 二进制或 shell 简介. [可选的开放代码注册](https://npmcn.com/package/%40bitefoundry/retrieviewer/INSTALLING.md) 单独; 断开 如果您明确允许的话, 登记在取消注册之前.

## 把它放进你自己的TUI

核心由主机驱动. 你的应用软件拥有面板,输入和时钟;小狗有 不接管 stdin/ stdout .

```js
import { createPetPlugin } from '@bitefoundry/retrieviewer/plugin';

const puppy = await createPetPlugin({
  host: {
    getSize: () => ({ columns: pane.width, rows: pane.height }),
    render: ({ text }) => pane.setContent(text),
    onError: error => logToYourApp(error),
  },
});
puppy.start();
// puppy.interact('ball') / puppy.interact('treat') / puppy.interact('tug')
// On unmount: puppy.dispose()
```

`pane` 财务报告和审定财务报表 `logToYourApp` 从你的应用程序. [插件生命周期](https://npmcn.com/package/%40bitefoundry/retrieviewer/PLUGIN.md) • 妇女 [核心/ JSONL 桥](https://npmcn.com/package/%40bitefoundry/retrieviewer/EMBEDDING.md) • 妇女 [可选的 OpenCode 适配器](https://npmcn.com/package/%40bitefoundry/retrieviewer/INSTALLING.md)。 。 。 . 原生的OpenCode gane有Windows/OpenCode 2.1.2主机证据; Codex, Claude, 等, 光标、格鲁克和反重力 **绝对值** 渲染器没有执行. 单靠MCP连接无法在这些客户端中插入一幅持续图.

## 可选的 StackBite 提醒

[堆栈 咬伤警告](https://npmcn.com/package/%40bitefoundry/retrieviewer/ATTENTION.md) 选择并读取当前 Room 元数据,而不包含 抓取屏幕,操作其他应用程序或自动批准请求. 一个 [可选付费的 DeepSeek/ OpenRouter 后端](https://npmcn.com/package/%40bitefoundry/retrieviewer/BRAIN.md) 可以判断匿名事件元数据; 离线规则仍然是默认并保存 已确认待通知.

没有等待模型就发出警报。 在 Windows 上, 座位名称和待定 类型在本地显示; 名称从未输入模型输入。 小狗来了,看 向边栏和替身走去 玻璃拼写 两个手势都可以在网站演示中播放. 窗口监视 也支持npm的PowerShell发射器. 已完成的工作检查标记没有提醒 事情还没有发生.

更新后, 运行在显示计算机上的 StackBite Seat 中 :

```sh
retrieviewer desktop --watch stackbite --brain openrouter
```

付费后端需要 `OPENROUTER_API_KEY` 在那个终端的环境下. 奥米 `--brain openrouter` 只有规则提醒。 先退出已有的同伴 与 `retrieviewer desktop-stop`。这些已安装的命令从任何文件夹工作; `node retrieviewer-cli.mjs` 用于在源检出中运行的开发者.

## 建设、贡献、友善

```sh
npm ci
npm test
npm run build:site
npm start
```

公用树包含已运出运行时间 Q5 艺术, 焦点运行时间/ 适应器 试验和再生产场地建造。 历史艺术实验,原文参考 故意不提供照片和私人工人/质量保证记录. 见 [捐款](https://npmcn.com/package/%40bitefoundry/retrieviewer/CONTRIBUTING.md) 财务报告和审定财务报表 [源范围](https://npmcn.com/package/%40bitefoundry/retrieviewer/SOURCE-SCOPE.md)。 。 。 . 兼容性报告受到欢迎——特别是真实的Mac测试和X11桌面.

## 代码和外套有不同的许可证

**代码:麻省理工学院. 艺术作品:CC BY-SA 4.0.** 允许商业再利用 各自条款。 酌情保留艺术品信贷和类似股票的条件; 完整软件包是 **不仅仅是麻省理工学院**。 。 。 .

[代码许可证](https://npmcn.com/package/%40bitefoundry/retrieviewer/LICENSE-CODE) • 妇女 [艺术作品术语](https://npmcn.com/package/%40bitefoundry/retrieviewer/ASSETS-LICENSE.md) • 妇女 [所需贷项](https://npmcn.com/package/%40bitefoundry/retrieviewer/ATTRIBUTION.md) • 妇女 [第三方通知](https://npmcn.com/package/%40bitefoundry/retrieviewer/THIRD-PARTY-NOTICES.md) • 妇女 [品牌通知](https://npmcn.com/package/%40bitefoundry/retrieviewer/TRADEMARKS.md)。 。 。 .

小狗的作品是用人工智能生成的图像和节目布局开发的, 地面和帧处理.

## 0.0.27 (单位:千美元)

猫在轮子上慢了下来,没有跳回更快的步道. 一个可见的球在它伸手时等待,被打出后会滚出并停留. 选择 在猫的Windows控制器中的玩具,或者在网络演示中尝试. 保存现有艺术品和两帧缓存.

## 0.0.26 (单位:千美元)

拖船时固定出行的艺术品和返回时两腿间隙 办法。 已存在的外形和两帧缓存被保留.

## 0.0.25 (简体中文)

球在小狗捡起后保持连接,并携带并放下. 后体封存保存对象,地球保持可见 在采集和进食之后。 艺术品和相框缓存没有变化.

## 0.0.24 (中文(简体) )

猫可以经过一顿会后再回想轮子或塔. 被动警报等待 进食或直接玩来完成. 节点桌面适配器限制已停顿的时间 所以延迟的帧不会关闭猫。 艺术作品和缓存保持不变.

## 0.0.23 (单位:千美元)

猫从被支持的爪子上起动起轮子 形成一跑道 然后走走 下来。 弯曲的脚步接触器 把它的爪子放入边缘 塔地升华厂 在提起后方前爪前 后方的下方没有受损. 增加了12幅图纸,保留了之前的77幅和两帧缓存.

## 0.022 资源

狗转过身来连接 通过被绑住的全身步骤, 与对接的爪子和 搭载着球锚 桌面控制器折叠成菜单按钮 。 那个狗 预览会暂停在取景口外,并在可见时恢复.

## 0.0.21 (单位:千美元)

猫现在通过站姿相接 在行走或上钩前 跳下来 断裂和小的入睡/入耳变化 两帧缓存。 一幅画中的一对相重叠的猫被取出. 狗离开 和回转 共享站点,带球附着在 明显的口罩。 代码仍为麻省理工学院.

## 0.0.20 经常预算:

修复由分窗画家引入的Windows闪存. 整个场景 再次通过一个稳定的透明窗口更新; 缓冲缩小和 隐藏状态的清理仍然存在。 艺术作品和行为没有变化. 见 [演示文稿固定和测量](https://npmcn.com/package/%40bitefoundry/retrieviewer/SPARSE-PAINT.md)。 。 。 .

## 0.0.19(历史;由闪烁器固定取代)

Windows 基本模式现在将远程内容分割为小漆区和 回收过大/隐藏地表。 同样的宠物,艺术品和行为。 实4K 150s测试:狗中位值22.6MiB / OS最高峰值36.5MiB;猫有塔/轮29.5 39.1MiB. 可选的观看和其他OS/浏览器主机保持各自独立的内存范围. 见 [测量和核查](https://npmcn.com/package/%40bitefoundry/retrieviewer/SPARSE-PAINT.md)。 。 。 .

## 0.0.18 (单位:千美元)

Windows x64 基本模式现在运行一个本地进程; 节点发射后退出. 现有的艺术和行为都一样 使用 `retrieviewer desktop --pet cat` 给生姜猫,或者在取窗器中选取. 只有一个宠物上膛. 可选 StackBite/LLM 监视保留了高模节点相容性 发动机。 Linux/macOS和浏览器预览保留了现有的主机架构. 两个物种都使用有索引的作物在当地装载. 见 [运行时间范围和测量](https://npmcn.com/package/%40bitefoundry/retrieviewer/NATIVE-RUNTIME.md)。 。 。 .

## 常见问题

### @bitefoundry/retrieviewer 是什么？

用于Windows和Linux X11的绒毛盲文桌面宠物,有实验性的macOS支持和可嵌入的TUI引擎\.

### 如何安装 @bitefoundry/retrieviewer？

在项目目录运行 npm install @bitefoundry/retrieviewer，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 retrieviewer、retrieviewer-stdio，可以用 npx retrieviewer 直接运行。

### @bitefoundry/retrieviewer 支持 TypeScript 吗？

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

### @bitefoundry/retrieviewer 支持 ESM 还是 CommonJS？

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

### @bitefoundry/retrieviewer 需要什么版本的 Node\.js？

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

### @bitefoundry/retrieviewer 可以商用吗？

@bitefoundry/retrieviewer 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @bitefoundry/retrieviewer 的下载量有多少？

根据 npm 官方下载统计，@bitefoundry/retrieviewer 在 2026/10/08 – 2026/11/06 这 30 天内被下载 5,388 次，日均约 180 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @bitefoundry/retrieviewer 还在维护吗？

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