# @ai-agent-forge/plugin-workspace-files 中文文档

规范地址：https://npmcn.com/package/%40ai-agent-forge/plugin-workspace-files/

版本：0\.88\.28
npm 元数据更新时间：2026-11-02T01:16:34.349Z
中文译文更新时间：2026-11-06T06:21:16.806Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40ai-agent-forge/plugin-workspace-files
原文对照：https://npmcn.com/package/%40ai-agent-forge/plugin-workspace-files/?lang=original
项目主页：https://github.com/agent-forge/agent-forge#readme
源码仓库：https://github.com/agent-forge/agent-forge

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

- 包体积（解压后）：142 kB，24 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.19\.0
- 运行依赖：2 个
- 首次发布：2026-09-28T16:27:39.787Z
- 最新版本发布：2026-11-02T01:16:34.158Z
- 近 30 天下载量：4456（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：61（近 12 个月 61 个）

## 中文简介

代理 Forge 的工作空间文件能力插件( 只读的工作空间 list/ workspace read/ workspace find 工具)

## 安装

```sh
npm install @ai-agent-forge/plugin-workspace-files
```

也可以使用：`pnpm add @ai-agent-forge/plugin-workspace-files`、`yarn add @ai-agent-forge/plugin-workspace-files`、`bun add @ai-agent-forge/plugin-workspace-files`

## README

# @ agent-forge/plugin-工作空间文件

工作空间文件能力插件 [福吉探员](https://github.com/agent-forge/agent-forge),从 主办单位 `src/plugins/workspace-files` (D-075 S3) (英语). 它登记了三种只读工具—— `workspace_list`, (中文(简体) ), `workspace_read`, (中文(简体) ), `workspace_find` ——完全通过不透明的主机拥有的工作空间参考操作;模式 从不提供或接收本地路径.

插件在加载时没有独立的文件系统绑定. 没有主机输入列表/读取/查找连接工具 报告明确 `unsupported` 结果; 想要真实文件访问的主机将自己的不透明ref文件主机绑定通过 他们的档案机器.

## 安装

```sh
# from a local checkout
agent-forge plugin install ./plugins/workspace-files

# from npm
agent-forge plugin install @ai-agent-forge/plugin-workspace-files
```

货包船有两艘货单: `agent-forge.json` (确定性插件解析器显示的生态系统)和 `plugin.json` (主机载重清单 `loadCapabilityPluginFromManifest`条目 `./dist/entry.js`) (中文(简体) ).

## 图书馆表面

`import { createNodeWorkspaceFilesAdapterV1, createWorkspaceFilesCapabilityFactoryV1 } from "@agent-forge/plugin-workspace-files";`

-   `createNodeWorkspaceFilesAdapterV1(options?)` ——只读适配器;需要主机注入 `list`编号 :`read`编号 :`find` 回调生成结果, 否则返回 `unsupported`。 。 。 .
-   `sanitizeWorkspaceFilesTextV1(value, maximum?)` ——从预览中编辑证书和主机路径.
-   `createWorkspaceFilesCapabilityFactoryV1(adapter)` - 将三个工作空间工具登记在 `CapabilityAPI`。 。 。 .
-   默认导出 `dist/entry.js` ——外部插件加载所使用的预编厂.

## 发展

```sh
npm install --ignore-scripts        # repo root, creates the workspace symlink
npm run build                       # plugins/workspace-files (tsgo)
npm test                            # vitest; the entry fidelity test requires `npm run build` first
```

## 常见问题

### @ai-agent-forge/plugin-workspace-files 是什么？

代理 Forge 的工作空间文件能力插件\( 只读的工作空间 list/ workspace read/ workspace find 工具\)

### 如何安装 @ai-agent-forge/plugin-workspace-files？

在项目目录运行 npm install @ai-agent-forge/plugin-workspace-files，或使用 pnpm add / yarn add / bun add。

### @ai-agent-forge/plugin-workspace-files 支持 TypeScript 吗？

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

### @ai-agent-forge/plugin-workspace-files 支持 ESM 还是 CommonJS？

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

### @ai-agent-forge/plugin-workspace-files 需要什么版本的 Node\.js？

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

### @ai-agent-forge/plugin-workspace-files 可以商用吗？

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

### @ai-agent-forge/plugin-workspace-files 的下载量有多少？

根据 npm 官方下载统计，@ai-agent-forge/plugin-workspace-files 在 2026/10/05 – 2026/11/03 这 30 天内被下载 4,456 次，日均约 149 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @ai-agent-forge/plugin-workspace-files 还在维护吗？

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