安装 Pipee →
Documentation

安装、启动，然后继续使用 Pi。

Pipee 是本地 Web UI。这里先完成产品安装，再分别说明 Pi Extension 与可选 Web Surface。

01 / INSTALL

全局安装 Pipee

使用 npm、pnpm 或 bun 全局安装。安装一次后，可以在任意项目目录启动。

安装边界

@yansircc/pipee 只安装 Web UI，不会迁移或复制你的 Pi Session。

02 / RUN

启动本地 Web UI

进入希望工作的项目目录，运行：

Terminal
pipee

Pipee 启动本地服务，并连接当前机器上的 Pi 工作环境。

03 / MODEL

三个概念，不混用

PiAgent runtime

拥有 Session、模型、上下文和 Extension API。

Pi ExtensionRuntime capability

拥有工具、事件、状态、服务和生命周期。

PipeeWeb UI

呈现 Pi，并承载 Extension 声明的可选界面。

04 / FIRST EXTENSION

创建 Pi Extension

Extension 首先必须作为 Pi 运行时能力独立成立。

src/extension.tsPi Extension
export default function (pi: ExtensionAPI) {
  pi.registerTool({
    name: "hello_pipee",
    description: "返回一个问候",
    parameters: Type.Object({}),
    async execute() { /* ... */ }
  })
}
05 / OPTIONAL WEB SURFACE

需要页面时，再接入 Pipee

Web Surface 是同一 Extension package 的可选资源。核心行为不能依赖 Pipee 才成立。

package.jsonOptional
"pipee": {
  "web": {
    "contract": "pipee/web-surface@2",
    "document": "./dist/web/index.html"
  }
}
继续阅读开发指南 →