# @fungi\.computer/corral 中文文档

规范地址：https://npmcn.com/package/%40fungi.computer/corral/

版本：0\.1\.31
npm 元数据更新时间：2026-11-15T06:03:54.419Z
中文译文更新时间：2026-11-15T19:02:00.087Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：15.2 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2026-10-17T00:54:50.272Z
- 最新版本发布：2026-11-15T06:03:54.223Z
- 近 30 天下载量：5718（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：34（近 12 个月 34 个）

## 中文简介

为Shiitake客户提供任择Herdr活动报告

## 安装

```sh
npm install @fungi.computer/corral
```

也可以使用：`pnpm add @fungi.computer/corral`、`yarn add @fungi.computer/corral`、`bun add @fungi.computer/corral`

## README

# Corral (`@fungi.computer/corral`(中文(简体) )

Corral报告一个Shiitake客户端当前活动在活性赫德面板. 这个 是一个可选的客户端扩展: 客户端提供活动, Herdr 拥有 和它的生命周期.

## 安装或设置

```sh
npm install @fungi.computer/corral
```

包船无害环境管理仅取决于 `effect` 财务报告和审定财务报表 [Shi](https://npmcn.com/package/%40fungi.computer/shiitake/README.md) 在运行时间。 它唯一的入口点, `@fungi.computer/corral`,将Shiitake客户端扩展导出为默认 导出和 `attachCorral` 对于提供自身活动流的宿主.

默认扩展为 `HERDR_ENV`, (中文(简体) ), `HERDR_SOCKET_PATH`,以及 `HERDR_PANE_ID` 从它的工艺环境。 只有当 `HERDR_ENV` 实值 `1` 并设置了套接字路径和窗格ID。 在这个环境之外, 附件没有效果.

## 快开始

这个示例附上了客户端提供的流. 闭幕 影响范围停止报告,并发布窗格报告:

```ts
import * as Effect from "effect/Effect";
import * as Exit from "effect/Exit";
import * as Scope from "effect/Scope";
import * as Stream from "effect/Stream";
import { attachCorral } from "@fungi.computer/corral";

const scope = await Effect.runPromise(Scope.make());
await Effect.runPromise(
  attachCorral(Stream.fromIterable([{ state: "idle" }, { state: "working" }]), {
    environment: {
      HERDR_ENV: "1",
      HERDR_SOCKET_PATH: "/path/to/herdr.sock",
      HERDR_PANE_ID: "pane-id",
    },
    onError: (error) => console.error("Herdr report failed", error),
  }).pipe(Scope.provide(scope)),
);
await Effect.runPromise(Scope.close(scope, Exit.void));
```

片段很说明问题:一个真正的客户端提供它的活活动流和 其管理环境中的Herdr值。 综合测试报告 并针对本地套接字服务器发布请求 [`test/activity.test.ts`](https://npmcn.com/package/%40fungi.computer/corral/test/activity.test.ts)。 。 。 .

## 核心概念

活动流包含 `idle`, (中文(简体) ), `working`, (中文(简体) ), `blocked`,或 `unknown`更正 报告从该流变化。 它不打开另一个会话监视或读取 a 会话数据库。 客户仍然负责生产活动。 这个 默认条目借用带有独立滑动最新值的 AsyncIterable 每台列车的订阅和调离信号. `attachCorral` 接受效果 流,包括带有已键入的流 `Error` 失败。 源代码和套接字错误 到达 `onError`;关闭范围仍然发布窗格报告。 真菌借来的 它现有的会话观测和命令交互存储。 打开的代理 问题、待决命令问题或浏览器手接报告 `blocked`。 。 。 . 回答它恢复了当前的活动。 代理人问题可能增加其简短 被屏蔽信件的页眉; 问事机构、 回答选择、 回答和 全权证书从未列入报告.

草药衍生物 `done` 当一个看不见的背景转回 `idle`它拥有 用户是否看到此完成 。 Corral 从不猜测完成从 无法观察.

`attachCorral` 需要一个效果范围。 当范围关闭时,Corral将取消 记者,关闭任何在飞行中的套接字,并发布当前窗格报告。 这个 发送 `pane.report_agent` 财务报告和审定财务报表 `pane.release_agent` 在赫尔德的API插座上 页:1 `fungi:agent:v1` 来源和 `fungi` 代理标签。 单通乘以印花 序列命令报告贯穿附件和进程重新启动.

## API 参考

见生成 [参考更正 API](https://npmcn.com/package/%40fungi.computer/corral/docs/api/README.md)默认导出 仅为附件 `shiitake.client/v1` 输入. `attachCorral` 是下层 直接提供活动流的主机的集成.

## 实例和检查

活动测试包括环境定位、活动变化、范围清理 关闭,并报告故障处理。 运行方式:

```sh
pnpm --filter @fungi.computer/corral test
```

## 限制和错误

Corral是可信赖的本地扩展代码,而不是沙盒. 它没有开始或停止 赫尔德服务,并不决定什么是成功的工作。 报告 释放请求是可选的IPC:每个请求限为2秒. 失败的是 转至 `onError`报告失败不会否决客户活动或 终端修复。 呼叫者拥有任何用户化的恢复.

电线合同跟随赫德 [代理人融合指南](https://herdr.dev/docs/add-herdr-support/) 联 合 国 [Pi 扩展](https://github.com/herdrdev/herdr/blob/v0.9.3/src/integration/assets/pi/herdr-agent-state.ts)。 。 。 .

## 贡献和许可证

Corral持有麻省理工学院执照. 见 [`LICENSE`](https://npmcn.com/package/%40fungi.computer/corral/LICENSE)。 。 。 .

## 常见问题

### @fungi\.computer/corral 是什么？

为Shiitake客户提供任择Herdr活动报告

### 如何安装 @fungi\.computer/corral？

在项目目录运行 npm install @fungi\.computer/corral，或使用 pnpm add / yarn add / bun add。

### @fungi\.computer/corral 支持 TypeScript 吗？

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

### @fungi\.computer/corral 支持 ESM 还是 CommonJS？

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

### @fungi\.computer/corral 可以商用吗？

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

### @fungi\.computer/corral 的下载量有多少？

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

### @fungi\.computer/corral 还在维护吗？

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