# @amaster\.ai/pi-storage 中文文档

规范地址：https://npmcn.com/package/%40amaster.ai/pi-storage/

版本：0\.1\.37
npm 元数据更新时间：2026-11-09T02:51:52.474Z
中文译文更新时间：2026-11-09T08:34:25.549Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40amaster.ai/pi-storage
原文对照：https://npmcn.com/package/%40amaster.ai/pi-storage/?lang=original
项目主页：https://github.com/TGYD-helige/pi#readme
源码仓库：https://github.com/TGYD-helige/pi

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

- 包体积（解压后）：297 kB，77 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：@prisma/client ^6\.19\.3
- 首次发布：2026-05-16T07:35:44.113Z
- 最新版本发布：2026-11-09T02:51:52.290Z
- 近 30 天下载量：3535（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：132（近 12 个月 132 个）

## 中文简介

Pi的运行时间恒定适配器.

## 安装

```sh
npm install @amaster.ai/pi-storage
```

也可以使用：`pnpm add @amaster.ai/pi-storage`、`yarn add @amaster.ai/pi-storage`、`bun add @amaster.ai/pi-storage`

## README

# @amaster.ai/ pi- storage (英语)

Pi的运行时间恒定适配器.

此软件包拥有会话的存储边界,记录誊本,内存,运行时事件,子代理运行,以及文物元数据. 它包括用于开发和桌面使用的本地JSON文件适配器,外加用于平台部署的MySQL/Prisma适配器.

## 条目点

-   `@amaster.ai/pi-storage`:稳定合同和 `createRuntimeStorage` 工厂.
-   `@amaster.ai/pi-storage/json`JSON文件适配器课.
-   `@amaster.ai/pi-storage/db`: DB适配器工厂和迁移跑道.
-   `@amaster.ai/pi-storage/internal`: 此单曲使用的内部助手 。 这些不属于稳定的公共API.

## 本地 JSON 存储

```ts
import { createRuntimeStorage } from "@amaster.ai/pi-storage";

const storage = createRuntimeStorage({
  mode: "json",
  agentDir: ".pi",
  eventLimits: {
    runtimeEvents: 1000,
    toolEvents: 1000,
    llmGenerationEvents: 1000,
  },
});
```

## DB 存储

```ts
import { createRuntimeStorage } from "@amaster.ai/pi-storage";
import { runDbMigrations } from "@amaster.ai/pi-storage/db";

await runDbMigrations({
  databaseUrl: process.env.DATABASE_URL!,
  redisUrl: process.env.REDIS_URL!,
});

const storage = createRuntimeStorage({
  mode: "db",
  agentDir: ".pi",
  databaseUrl: process.env.DATABASE_URL,
  redisUrl: process.env.REDIS_URL,
  eventLimits: {
    runtimeEvents: 1000,
    toolEvents: 1000,
    llmGenerationEvents: 1000,
  },
});
```

会议 `metadata` 是一个可选的 JSON 对象,由两个适配器保存和阅读。 DB 读取忽略了缺失或错误的元数据.

## 公共API政策

类型和合同 `@amaster.ai/pi-shared` 并且从根库出入口再出口。 混凝土适配器通过明显的子路径入站被暴露出,因此应用可以依赖于所需要最小的稳定地表.

### 诊断失败

JSON商店在主机畸形时使用有效的备份并登录该恢复. 如果无法恢复,则读取失败,而不是初始化一个空库并冒着替换现有数据的风险.

## 常见问题

### @amaster\.ai/pi-storage 是什么？

Pi的运行时间恒定适配器\.

### 如何安装 @amaster\.ai/pi-storage？

在项目目录运行 npm install @amaster\.ai/pi-storage，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 pi-storage-migrate，可以用 npx pi-storage-migrate 直接运行。

### @amaster\.ai/pi-storage 支持 TypeScript 吗？

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

### @amaster\.ai/pi-storage 支持 ESM 还是 CommonJS？

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

### @amaster\.ai/pi-storage 可以商用吗？

@amaster\.ai/pi-storage 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @amaster\.ai/pi-storage 的下载量有多少？

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

### @amaster\.ai/pi-storage 还在维护吗？

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