# @reinsjs/ui-agui 中文文档

规范地址：https://npmcn.com/package/%40reinsjs/ui-agui/

版本：0\.3\.3
npm 元数据更新时间：2026-11-02T06:34:52.628Z
中文译文更新时间：2026-11-02T08:38:10.921Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40reinsjs/ui-agui
原文对照：https://npmcn.com/package/%40reinsjs/ui-agui/?lang=original
项目主页：https://github.com/AdRate-io/reins/tree/main/packages/ui-agui#readme
源码仓库：https://github.com/AdRate-io/reins

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

- 包体积（解压后）：63.4 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：2 个
- 首次发布：2026-09-14T04:08:11.921Z
- 最新版本发布：2026-11-02T06:34:52.363Z
- 已发布版本数：8（近 12 个月 8 个）

## 中文简介

缰绳-时间轴事件→AG-UI协议事件（@reinsjs/server的编码器，或独立的映射器）

## 安装

```sh
npm install @reinsjs/ui-agui
```

也可以使用：`pnpm add @reinsjs/ui-agui`、`yarn add @reinsjs/ui-agui`、`bun add @reinsjs/ui-agui`

## README

# @reinsjs / ui-agui

时间轴事件→ [AG-UI](https://docs.ag-ui.com/) 协议的事件。REINS并没有发明一个前端协议；这个包使任何AG-UI客户端（CopilotKit和朋友）都成为一个代理的工作UI。零运行时依赖；针对每个发出的事件进行验证 `@ag-ui/core`这是测试中的官方模式。

```bash
pnpm add @reinsjs/ui-agui
```

```ts
import { aguiEncoding } from "@reinsjs/ui-agui"
import { createAgentHandler } from "@reinsjs/server"

// `agentDefinition` is the AgentDefinition (loop config); with `createAgent()` that is `agent.definition`
export const POST = createAgentHandler(agentDefinition, { encode: aguiEncoding() })
```

雨伞 `@reinsjs/agent` 包已经使用 `aguiEncoding()` 的默认值 `createAgent(...).handler`.

## 映射

| 时间轴 | AG-UI |
| --- | --- |
| 运行start / `result` | `RUN_STARTED`， `RUN_FINISHED` （`outcome: success` 或者 `interrupt` 每个条目一个 `Interruption`，全 `RunResult` -包括已签署的 `state` ——在 `result`)， `RUN_ERROR` |
| `model_text` （+流增量） | `TEXT_MESSAGE_START` / `_CONTENT` / `_END` |
| `model_thinking` | `REASONING_*` |
| `tool_call`， `tool_result` | `TOOL_CALL_START` / `_ARGS` / `_END`， `TOOL_CALL_RESULT` |
| `user_message` | `MESSAGES_SNAPSHOT`\-兼容用户消息 |
| 其他的(`system_note`， `compaction`， `approval_*`， `budget_usage`， `run_paused` …) | `CUSTOM` 与 `name` =事件类型，事件为 `value` |

中断携带了UI需要响应它们的东西：一个 `approval` 有 `toolCallId`请求摘要和策略id；一个 `subagent` 中断（等待批准的嵌套代理）具有 `metadata.childSessionId` 再加上孩子自己的干扰——把决定退回去 `sessionId: childSessionId`.

`mapEvent` / `AGUI_MAPPING` 为希望在没有流编码器的情况下进行纯事件转换的主机导出。 `@reinsjs/ui-agui/demo/index.html` 是一个与对话的无依赖页面吗 `@reinsjs/server` 并渲染溪流； `examples/minimal` 服务于它。

## 文档

`docs/系统全景图_模块盘点/ui-agui.md` -在中文中，在存储库根。

MIT©2026 newate Limited

## 常见问题

### @reinsjs/ui-agui 是什么？

缰绳-时间轴事件→AG-UI协议事件（@reinsjs/server的编码器，或独立的映射器）

### 如何安装 @reinsjs/ui-agui？

在项目目录运行 npm install @reinsjs/ui-agui，或使用 pnpm add / yarn add / bun add。

### @reinsjs/ui-agui 支持 TypeScript 吗？

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

### @reinsjs/ui-agui 支持 ESM 还是 CommonJS？

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

### @reinsjs/ui-agui 需要什么版本的 Node\.js？

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

### @reinsjs/ui-agui 可以商用吗？

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

### @reinsjs/ui-agui 还在维护吗？

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