@agent-assistant/vfs

中文文档
0.4.37发布于 2026/10/04MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 2万

Provider-neutral virtual filesystem contracts and Bash-oriented CLI runner for assistant products

原始使用文档

@agent-assistant/vfs

Provider-neutral virtual filesystem contracts and a Bash-oriented CLI runner for assistant products.

The package does not know about RelayFile, Linear, Slack, GitHub, or any product-specific path grammar. Products adapt their own stores to VfsProvider; the shared package owns command parsing, output conventions, and the small contract that lets an assistant inspect a filesystem-like knowledge surface from Bash.

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),
});

Commands

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

Add --json to list, tree, read, search, or stat for machine-readable output.

版本与发布记录

@agent-assistant/vfs 共发布 60 个版本,首次发布于 2026/04/17;过去 12 个月发布了 60 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.4.37latest2026/10/041 个月前
0.4.362026/10/041 个月前
0.4.352026/05/235 个月前
0.4.332026/05/155 个月前
0.4.322026/05/125 个月前
0.4.312026/05/086 个月前

关于 @agent-assistant/vfs 的常见问题

@agent-assistant/vfs 是什么?

Provider-neutral virtual filesystem contracts and Bash-oriented CLI runner for assistant products

如何安装 @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 和提交记录判断。