# @agent-assistant/vfs 中文文档

规范地址：https://npmcn.com/package/%40agent-assistant/vfs/

版本：0\.4\.37
npm 元数据更新时间：2026-10-04T06:55:42.150Z
中文译文更新时间：2026-11-05T21:09:27.274Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：51.1 kB，28 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-04-17T12:00:18.219Z
- 最新版本发布：2026-10-04T06:55:41.827Z
- 近 30 天下载量：20426（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：60（近 12 个月 60 个）

## 中文简介

助理产品供应商中立虚拟文件系统合同和面向巴什的CLI跑车

## 安装

```sh
npm install @agent-assistant/vfs
```

也可以使用：`pnpm add @agent-assistant/vfs`、`yarn add @agent-assistant/vfs`、`bun add @agent-assistant/vfs`

## README

# @ agent-assistant/vfs(代理助理/副助理)

供应商中立的虚拟文件系统合同和面向Bash的助理产品的CLI跑车.

该套件不了解RelayFile,Linear,Slack,GitHub,或任何产品特有路径语法. 产品使自己的商店适应 `VfsProvider`;共享软件包拥有命令解析,输出常规,以及让助理检查从巴什站出类似文件系统的知识表面的小型合同.

```typescript
import { runVfsCli } from '@agent-assistant/vfs';
import type { VfsProvider } from '@agent-assistant/vfs';

const provider: VfsProvider = {
  list: async (path) => [{ path: `${path}/notes.md`, type: 'file' }],
  read: async (path) => ({ path, content: 'hello' }),
  search: async (query) => [{ path: '/notes.md', type: 'file', snippet: query }],
};

process.exitCode = await runVfsCli({
  name: 'product-vfs',
  provider,
  argv: process.argv.slice(2),
});
```

## 图标

```bash
product-vfs list /linear --depth 2 --limit 50
product-vfs tree /linear --depth 3
product-vfs read /linear/issues/ABC-123/issue.json
product-vfs search "roadmap Q2" --provider linear --limit 10
product-vfs stat /linear/issues/ABC-123/issue.json
```

添加 `--json` 改为 `list`, (中文(简体) ), `tree`, (中文(简体) ), `read`, (中文(简体) ), `search`,或 `stat` 用于机器可读输出.

## 常见问题

### @agent-assistant/vfs 是什么？

助理产品供应商中立虚拟文件系统合同和面向巴什的CLI跑车

### 如何安装 @agent-assistant/vfs？

在项目目录运行 npm install @agent-assistant/vfs，或使用 pnpm add / yarn add / bun add。

### @agent-assistant/vfs 支持 TypeScript 吗？

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

### @agent-assistant/vfs 支持 ESM 还是 CommonJS？

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

### @agent-assistant/vfs 可以商用吗？

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

### @agent-assistant/vfs 的下载量有多少？

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

### @agent-assistant/vfs 还在维护吗？

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