扩展
pi 可以创建扩展。让它为你构建一个吧。
扩展是用于扩展 pi 行为的 TypeScript 模块。它们可以订阅生命周期事件、注册可供 LLM 调用的自定义工具、添加命令等。
放置位置 /reload: 将扩展放在
~/.pi/agent/extensions/(全局)或.pi/extensions/(项目本地)以实现自动发现。仅在快速测试时使用pi -e ./path.ts。位于自动发现位置的扩展可以通过/reload热重载。
核心能力:
- 自定义工具 - 通过
pi.registerTool()注册可供 LLM 调用的工具 - 事件拦截 - 阻止或修改工具调用、注入上下文、自定义压缩
- 用户交互 - 通过
ctx.ui提示用户(选择、确认、输入、通知) - 自定义 UI 组件 - 通过
ctx.ui.custom()实现完整的 TUI 组件及键盘输入 - 自定义命令 - 通过
pi.registerCommand()注册类似/mycommand的命令 - 会话持久化 - 通过
pi.appendEntry()存储可在重启后幸存的状态 - 自定义渲染 - 控制工具调用/结果和消息在 TUI 中的显示方式
示例用例:
- 权限门控(在
rm -rf、sudo等操作前确认) - Git 检查点(每次轮次暂存,分支切换时恢复)
- 路径保护(阻止写入
.env、node_modules/) - 自定义压缩(按你的方式总结对话)
- 对话摘要(参见
summarize.ts示例) - 交互式工具(问题、向导、自定义对话框)
- 有状态工具(待办列表、连接池)
- 外部集成(文件监听器、Webhook、CI 触发器)
- 等待时的游戏(参见
snake.ts示例)
参见 examples/extensions/ 获取可工作的实现。
目录 Table of Contents
- 快速开始 Quick Start
- 扩展位置 Extension Locations
- 可用导入 Available Imports
- 编写扩展 Writing an Extension
- 事件 Events
- ExtensionContext
- ExtensionCommandContext
- ExtensionAPI 方法 ExtensionAPI Methods
- 状态管理 State Management
- 自定义工具 Custom Tools
- 自定义 UI Custom UI
- 错误处理 Error Handling
- 模式行为 Mode Behavior
- 示例参考 Examples Reference
快速开始 Quick Start
创建 ~/.pi/agent/extensions/my-extension.ts:
import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
import { Type } from "typebox";
export default function (pi: ExtensionAPI) {
// 响应事件
pi.on("session_start", async (_event, ctx) => {
ctx.ui.notify("扩展已加载!", "info");
});
pi.on("tool_call", async (event, ctx) => {
if (event.toolName === "bash" && event.input.command?.includes("rm -rf")) {
const ok = await ctx.ui.confirm("危险操作!", "允许 rm -rf 吗?");
if (!ok) return { block: true, reason: "已被用户阻止" };
}
});
// 注册自定义工具
pi.registerTool({
name: "greet",
label: "Greet",
description: "按名称问候某人",
parameters: Type.Object({
name: Type.String({ description: "要问候的名称" }),
}),
async execute(toolCallId, params, signal, onUpdate, ctx) {
return {
content: [{ type: "text", text: `你好, ${params.name}!` }],
details: {},
};
},
});
// 注册命令
pi.registerCommand("hello", {
description: "打个招呼",
handler: async (args, ctx) => {
ctx.ui.notify(`你好 ${args || "世界"}!`, "info");
},
});
}使用 --extension(或 -e)标志测试:
pi -e ./my-extension.ts扩展位置 Extension Locations
安全: 扩展以你的完整系统权限运行,可以执行任意代码。仅从你信任的来源安装。
扩展从受信任的位置自动发现。项目本地的 .pi/extensions 条目仅在项目被信任后加载。
| 位置 Location | 范围 Scope |
|---|---|
~/.pi/agent/extensions/*.ts | 全局(所有项目) |
~/.pi/agent/extensions/*/index.ts | 全局(子目录) |
.pi/extensions/*.ts | 项目本地 |
.pi/extensions/*/index.ts | 项目本地(子目录) |
通过 settings.json 添加更多路径:
{
"packages": [
"npm:@foo/bar@1.0.0",
"git:github.com/user/repo@v1"
],
"extensions": [
"/path/to/local/extension.ts",
"/path/to/local/extension/dir"
]
}要通过 npm 或 git 作为 pi 包共享扩展,请参见 packages.md。
可用导入 Available Imports
| 包 Package | 用途 Purpose |
|---|---|
@earendil-works/pi-coding-agent | 扩展类型(ExtensionAPI、ExtensionContext、事件) |
typebox | 工具参数的模式定义 |
@earendil-works/pi-ai | AI 工具(StringEnum 用于兼容 Google 的枚举) |
@earendil-works/pi-tui | 用于自定义渲染的 TUI 组件 |
npm 依赖同样可用。在扩展旁(或其父目录)添加 package.json,运行 npm install,从 node_modules/ 的导入会自动解析。
对于通过 pi install 安装的分布式 pi 包(npm 或 git),运行时依赖必须在 dependencies 中。包安装默认使用生产安装(npm install --omit=dev),因此 devDependencies 在运行时不可用;当配置了 npmCommand 时,git 包使用普通的 install 以兼容包装器。
Node.js 内置模块(node:fs、node:path 等)也可用。
编写扩展 Writing an Extension
扩展导出一个接收 ExtensionAPI 的默认工厂函数。工厂可以是同步的或异步的:
import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
export default function (pi: ExtensionAPI) {
// 订阅事件
pi.on("event_name", async (event, ctx) => {
// ctx.ui 用于用户交互
const ok = await ctx.ui.confirm("标题", "你确定吗?");
ctx.ui.notify("完成!", "info");
ctx.ui.setStatus("my-ext", "处理中..."); // 页脚状态
ctx.ui.setWidget("my-ext", ["第1行", "第2行"]); // 编辑器上方的小部件(默认)
});
// 注册工具、命令、快捷键、标志
pi.registerTool({ ... });
pi.registerCommand("name", { ... });
pi.registerShortcut("ctrl+x", { ... });
pi.registerFlag("my-flag", { ... });
}扩展通过 jiti 加载,因此 TypeScript 无需编译即可使用。
如果工厂返回 Promise,pi 会在继续启动前等待它。这意味着异步初始化会在 session_start、resources_discover 以及通过 pi.registerProvider() 排队注册的提供商刷新完成之前执行完毕。
异步工厂函数 Async factory functions
使用异步工厂进行一次性启动工作,例如获取远程配置或动态发现可用模型。
import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
export default async function (pi: ExtensionAPI) {
const response = await fetch("http://localhost:1234/v1/models");
const payload = (await response.json()) as {
data: Array<{
id: string;
name?: string;
context_window?: number;
max_tokens?: number;
}>;
};
pi.registerProvider("local-openai", {
baseUrl: "http://localhost:1234/v1",
apiKey: "$LOCAL_OPENAI_API_KEY",
api: "openai-completions",
models: payload.data.map((model) => ({
id: model.id,
name: model.name ?? model.id,
reasoning: false,
input: ["text"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: model.context_window ?? 128000,
maxTokens: model.max_tokens ?? 4096,
})),
});
}此模式使获取的模型在正常启动期间和 pi --list-models 时可用。
长期存活资源与关闭 Long-lived resources and shutdown
扩展工厂可能在从未启动会话的调用中运行。不要在工厂中启动后台资源,例如进程、套接字、文件监听器或定时器。
将后台资源启动推迟到 session_start 或需要该资源的命令/工具/事件。注册一个幂等的 session_shutdown 处理器来关闭你启动的任何会话范围内的资源。
扩展风格 Extension Styles
单文件 - 最简单,适合小型扩展:
~/.pi/agent/extensions/
└── my-extension.ts带 index.ts 的目录 - 适合多文件扩展:
~/.pi/agent/extensions/
└── my-extension/
├── index.ts # 入口点(导出默认函数)
├── tools.ts # 辅助模块
└── utils.ts # 辅助模块带依赖的包 - 适合需要 npm 包的扩展:
~/.pi/agent/extensions/
└── my-extension/
├── package.json # 声明依赖和入口点
├── package-lock.json
├── node_modules/ # npm install 之后
└── src/
└── index.ts// package.json
{
"name": "my-extension",
"dependencies": {
"zod": "^3.0.0",
"chalk": "^5.0.0"
},
"pi": {
"extensions": ["./src/index.ts"]
}
}在扩展目录中运行 npm install,然后从 node_modules/ 的导入会自动生效。
事件 Events
生命周期概览 Lifecycle Overview
pi 启动
│
├─► project_trust(仅用户/全局和 CLI 扩展,在项目资源加载前)
├─► session_start { reason: "startup" }
└─► resources_discover { reason: "startup" }
│
▼
用户发送提示 ─────────────────────────────────────────┐
│ │
├─►(先检查扩展命令,找到则绕过) │
├─► input(可拦截、转换或处理) │
├─►(如果未处理,则展开技能/模板) │
├─► before_agent_start(可注入消息、修改系统提示) │
├─► agent_start │
├─► message_start / message_update / message_end │
│ │
│ ┌─── 轮次(LLM 调用工具时重复) ───┐ │
│ │ │ │
│ ├─► turn_start │ │
│ ├─► context(可修改消息) │ │
│ ├─► before_provider_headers(可变更请求头) │
│ ├─► before_provider_request(可检查或替换载荷) │
│ ├─► after_provider_response(状态 + 请求头,在流消费前)│
│ │ │ │
│ │ LLM 响应,可能调用工具: │
│ │ ├─► tool_execution_start │ │
│ │ ├─► tool_call(可阻止) │ │
│ │ ├─► tool_execution_update │ │
│ │ ├─► tool_result(可修改) │ │
│ │ └─► tool_execution_end │ │
│ │ │ │
│ └─► turn_end │ │
│ │
├─► agent_end │
└─► agent_settled(无重试/压缩/后续消息) │
│
用户发送另一个提示 ◄──────────────────────────────────────┘
/new(新会话)或 /resume(切换会话)
├─► session_before_switch(可取消)
├─► session_shutdown
├─► session_start { reason: "new" | "resume", previousSessionFile? }
└─► resources_discover { reason: "startup" }
/fork 或 /clone
├─► session_before_fork(可取消)
├─► session_shutdown
├─► session_start { reason: "fork", previousSessionFile }
└─► resources_discover { reason: "startup" }
/name 或 pi.setSessionName()
└─► session_info_changed
/compact 或自动压缩
├─► session_before_compact(可取消或自定义)
└─► session_compact
/tree 导航
├─► session_before_tree(可取消或自定义)
└─► session_tree
/model 或 Ctrl+P(模型选择/切换)
├─► thinking_level_select(如果模型更改改变/限制思考级别)
└─► model_select
思考级别更改(设置、快捷键、pi.setThinkingLevel())
└─► thinking_level_select
退出(Ctrl+C、Ctrl+D、SIGHUP、SIGTERM)
└─► session_shutdown启动事件 Startup Events
project_trust
在 pi 决定是否信任带有动态配置(.pi 或 .agents/skills)的项目之前触发。它在启动期间和会话替换(例如 /resume)进入工作目录但信任尚未在当前进程中解析时运行。仅用户/全局扩展和 CLI -e 扩展参与;项目本地扩展在信任解析完成之前不会加载。
pi.on("project_trust", async (event, ctx) => {
// event.cwd - 当前工作目录
// ctx 具有有限的信任上下文:cwd、mode、hasUI 以及 select/confirm/input/notify UI 辅助方法
if (await ctx.ui.confirm("信任此项目?", event.cwd)) {
return { trusted: "yes", remember: true };
}
return { trusted: "undecided" };
});project_trust 处理器必须返回 { trusted: "yes" | "no" | "undecided" }。返回 "yes" 或 "no" 的用户/全局或 CLI 扩展拥有决定权;第一个 yes/no 决定胜出并抑制内置的信任提示。使用 remember: true 来持久化 yes/no 决定;否则仅适用于当前进程。返回 "undecided" 让后续处理器或内置信任流程决定。在提示前检查 ctx.hasUI。如果没有处理器返回 yes/no,则继续正常的信任解析:首先应用已保存的 trust.json 决定,然后 defaultProjectTrust 控制 pi 是询问、信任还是默认拒绝。
资源事件 Resource Events
resources_discover
在 session_start 之后触发,以便扩展可以贡献额外的技能、提示和主题路径。启动路径使用 reason: "startup"。重载使用 reason: "reload"。
pi.on("resources_discover", async (event, _ctx) => {
// event.cwd - 当前工作目录
// event.reason - "startup" | "reload"
return {
skillPaths: ["/path/to/skills"],
promptPaths: ["/path/to/prompts"],
themePaths: ["/path/to/themes"],
};
});会话事件 Session Events
有关会话存储内部机制和 SessionManager API,请参见 Session Format。
session_start
当会话启动、加载或重载时触发。
pi.on("session_start", async (event, ctx) => {
// event.reason - "startup" | "reload" | "new" | "resume" | "fork"
// event.previousSessionFile - 存在于 "new"、"resume" 和 "fork" 中
ctx.ui.notify(`会话: ${ctx.sessionManager.getSessionFile() ?? "临时"}`, "info");
});session_info_changed
当通过 /name、RPC 或 pi.setSessionName() 设置了当前会话显示名称时触发。
pi.on("session_info_changed", async (event, ctx) => {
// event.name - 当前规范化的名称,如果已清除则为 undefined
ctx.ui.notify(`会话已重命名: ${event.name ?? "(无)"}`, "info");
});session_before_switch
在开始新会话(/new)或切换会话(/resume)之前触发。
pi.on("session_before_switch", async (event, ctx) => {
// event.reason - "new" 或 "resume"
// event.targetSessionFile - 要切换到的会话(仅适用于 "resume")
if (event.reason === "new") {
const ok = await ctx.ui.confirm("清空?", "删除所有消息?");
if (!ok) return { cancel: true };
}
});成功切换或新建会话操作后,pi 为旧的扩展实例触发 session_shutdown,为新会话重载并重新绑定扩展,然后以 reason: "new" | "resume" 和 previousSessionFile 触发 session_start。
在 session_shutdown 中执行清理工作,然后在 session_start 中重建任何内存状态。
session_before_fork
当通过 /fork 分支或通过 /clone 克隆时触发。
pi.on("session_before_fork", async (event, ctx) => {
// event.entryId - 所选条目的 ID
// event.position - "/fork" 为 "before","/clone" 为 "at"
return { cancel: true }; // 取消分支/克隆
// 或者
return { skipConversationRestore: true }; // 保留供将来对话恢复控制使用
});成功分支或克隆后,pi 为旧的扩展实例触发 session_shutdown,为新会话重载并重新绑定扩展,然后以 reason: "fork" 和 previousSessionFile 触发 session_start。
在 session_shutdown 中执行清理工作,然后在 session_start 中重建任何内存状态。
session_before_compact / session_compact
在压缩时触发。详情请参见 compaction.md。
pi.on("session_before_compact", async (event, ctx) => {
const { preparation, branchEntries, customInstructions, reason, willRetry, signal } = event;
// reason - "manual" (/compact)、"threshold" 或 "overflow"
// willRetry - 中断的轮次是否在压缩后重试(溢出恢复)
// 取消:
return { cancel: true };
// 自定义摘要:
return {
compaction: {
summary: "...",
firstKeptEntryId: preparation.firstKeptEntryId,
tokensBefore: preparation.tokensBefore,
}
};
});
pi.on("session_compact", async (event, ctx) => {
// event.compactionEntry - 保存的压缩
// event.fromExtension - 扩展是否提供了压缩
// event.reason - "manual" (/compact)、"threshold" 或 "overflow"
// event.willRetry - 中断的轮次是否在压缩后重试(溢出恢复)
});session_before_tree / session_tree
在 /tree 导航时触发。有关树导航概念,请参见 Sessions。
pi.on("session_before_tree", async (event, ctx) => {
const { preparation, signal } = event;
return { cancel: true };
// 或提供自定义摘要:
return { summary: { summary: "...", details: {} } };
});
pi.on("session_tree", async (event, ctx) => {
// event.newLeafId、oldLeafId、summaryEntry、fromExtension
});session_shutdown
在已启动的会话运行时被拆除之前触发。使用此事件清理从 session_start 或其他会话范围钩子打开的资源。
pi.on("session_shutdown", async (event, ctx) => {
// event.reason - "quit" | "reload" | "new" | "resume" | "fork"
// event.targetSessionFile - 会话替换流程的目标会话
// 清理、保存状态等
});代理事件 Agent Events
before_agent_start
在用户提交提示后、代理循环开始前触发。可以注入消息和/或修改系统提示。
pi.on("before_agent_start", async (event, ctx) => {
// event.prompt - 用户的提示文本
// event.images - 附加的图像(如果有)
// event.systemPrompt - 当前为此处理器链接的系统提示
// (包括之前 before_agent_start 处理器的更改)
// event.systemPromptOptions - 用于构建系统提示的结构化选项
// .customPrompt - 任何自定义系统提示(来自 --system-prompt、SYSTEM.md 或自定义模板)
// .selectedTools - 提示中当前激活的工具
// .toolSnippets - 每个工具的一行描述
// .promptGuidelines - 自定义指导要点
// .appendSystemPrompt - 来自 --append-system-prompt 标志的文本
// .cwd - 工作目录
// .contextFiles - AGENTS.md 文件和其他已加载的上下文文件
// .skills - 已加载的技能
return {
// 注入持久消息(存储在会话中,发送给 LLM)
message: {
customType: "my-extension",
content: "为 LLM 提供的额外上下文",
display: true,
},
// 替换此轮次的系统提示(跨扩展链接)
systemPrompt: event.systemPrompt + "\n\n此轮次的额外指令...",
};
});systemPromptOptions 字段为扩展提供了与 Pi 用来构建系统提示相同的结构化数据。这让你可以检查 Pi 已加载的内容——自定义提示、指导原则、工具片段、上下文文件、技能——而无需重新发现资源或重新解析标志。当你的扩展需要对系统提示进行深度、有信息的更改,同时尊重用户提供的配置时使用。
在 before_agent_start 内部,event.systemPrompt 和 ctx.getSystemPrompt() 都反映了当前处理器的链接系统提示。后续的 before_agent_start 处理器仍然可以再次修改它。
agent_start / agent_end / agent_settled
agent_start 在底层代理运行开始时触发。agent_end 在该运行结束时触发,但 Pi 可能仍然会自动重试、自动压缩并重试,或继续处理排队的后续消息。对于需要知道 Pi 不会继续自动运行的状态集成,使用 agent_settled。
pi.on("agent_start", async (_event, ctx) => {});
pi.on("agent_end", async (event, ctx) => {
// event.messages - 来自此底层运行的消息
});
pi.on("agent_settled", async (_event, ctx) => {
// 除非另一个扩展启动了新的运行,否则此处 ctx.isIdle() 为 true
});turn_start / turn_end
每个轮次(一次 LLM 响应 + 工具调用)触发。
pi.on("turn_start", async (event, ctx) => {
// event.turnIndex、event.timestamp
});
pi.on("turn_end", async (event, ctx) => {
// event.turnIndex、event.message、event.toolResults
});message_start / message_update / message_end
为消息生命周期更新触发。
message_start和message_end为用户、助手和 toolResult 消息触发。message_update为助手流式更新触发。message_end处理器可以返回{ message }来替换最终确定的消息。替换必须保持相同的role。
pi.on("message_start", async (event, ctx) => {
// event.message
});
pi.on("message_update", async (event, ctx) => {
// event.message
// event.assistantMessageEvent(逐令牌流事件)
});
pi.on("message_end", async (event, ctx) => {
if (event.message.role !== "assistant") return;
return {
message: {
...event.message,
usage: {
...event.message.usage,
cost: {
...event.message.usage.cost,
total: 0.123,
},
},
},
};
});tool_execution_start / tool_execution_update / tool_execution_end
为工具执行生命周期更新触发。
在并行工具模式下:
tool_execution_start在预检阶段按助手源顺序发送tool_execution_update事件可能跨工具交错tool_execution_end在每个工具完成后按工具完成顺序发送- 最终的
toolResult消息事件仍然在之后按助手源顺序发送
pi.on("tool_execution_start", async (event, ctx) => {
// event.toolCallId、event.toolName、event.args
});
pi.on("tool_execution_update", async (event, ctx) => {
// event.toolCallId、event.toolName、event.args、event.partialResult
});
pi.on("tool_execution_end", async (event, ctx) => {
// event.toolCallId、event.toolName、event.result、event.isError
});context
在每次 LLM 调用前触发。非破坏性地修改消息。有关消息类型,请参见 Session Format。
pi.on("context", async (event, ctx) => {
// event.messages - 深拷贝,可以安全修改
const filtered = event.messages.filter(m => !shouldPrune(m));
return { messages: filtered };
});before_provider_headers
在出站 HTTP 请求头组装完成后触发。用于添加、覆盖或移除请求头。
处理器原地修改 event.headers。将键设置为字符串以添加或覆盖,或设置为 null 以删除。
pi.on("before_provider_headers", (event, ctx) => {
// 添加或覆盖——例如用于网关跟踪/归因的会话 ID
event.headers["x-session-id"] = ctx.sessionManager.getSessionId();
// 删除 pi 为此调用添加的跟踪头
event.headers["X-OpenRouter-Title"] = null;
});每次提供商请求运行一次;重试重用相同的请求头而不是重新触发钩子。
before_provider_request
在提供商特定的载荷构建完成后、请求发送前触发。处理器按扩展加载顺序运行。返回 undefined 保持载荷不变。返回任何其他值会替换后续处理器和实际请求的载荷。
此钩子可以重写提供商级别的系统指令或完全删除它们。这些载荷级别的更改不会反映在 ctx.getSystemPrompt() 中,后者报告的是 Pi 的系统提示字符串,而不是最终的序列化提供商载荷。
pi.on("before_provider_request", (event, ctx) => {
console.log(JSON.stringify(event.payload, null, 2));
// 可选:替换载荷
// return { ...event.payload, temperature: 0 };
});这主要用于调试提供商序列化和缓存行为。
after_provider_response
在收到 HTTP 响应后、消费其流式内容前触发。处理器按扩展加载顺序运行。
pi.on("after_provider_response", (event, ctx) => {
// event.status - HTTP 状态码
// event.headers - 规范化的响应头
if (event.status === 429) {
console.log("速率受限", event.headers["retry-after"]);
}
});请求头的可用性取决于提供商和传输方式。抽象 HTTP 响应的提供商可能不会暴露请求头。
模型事件 Model Events
model_select
当通过 /model 命令、模型切换(Ctrl+P)或会话恢复更改模型时触发。
pi.on("model_select", async (event, ctx) => {
// event.model - 新选择的模型
// event.previousModel - 之前的模型(首次选择时为 undefined)
// event.source - "set" | "cycle" | "restore"
const prev = event.previousModel
? `${event.previousModel.provider}/${event.previousModel.id}`
: "无";
const next = `${event.model.provider}/${event.model.id}`;
ctx.ui.notify(`模型已更改 (${event.source}): ${prev} -> ${next}`, "info");
});使用此事件在活跃模型更改时更新 UI 元素(状态栏、页脚)或执行特定于模型的初始化。
thinking_level_select
当思考级别更改时触发。此事件仅为通知;处理器返回值将被忽略。
pi.on("thinking_level_select", async (event, ctx) => {
// event.level - 新选择的思考级别
// event.previousLevel - 之前的思考级别
ctx.ui.setStatus("thinking", `思考级别: ${event.level}`);
});当 pi.setThinkingLevel()、模型更改或内置思考级别控制更改活跃思考级别时,使用此事件更新扩展 UI。
工具事件 Tool Events
tool_call
在 tool_execution_start 之后、工具执行之前触发。可以阻止。 使用 isToolCallEventType 来缩小范围并获取类型化输入。
在 tool_call 运行之前,pi 等待之前发出的 Agent 事件通过 AgentSession 完成排空。这意味着 ctx.sessionManager 通过当前的助手工具调用消息保持最新。
在默认的并行工具执行模式下,来自同一条助手消息的兄弟工具调用按顺序预检,然后并发执行。tool_call 不保证在同一条助手消息的 ctx.sessionManager 中看到兄弟工具结果。
event.input 是可变的。原地修改它以在执行为修补工具参数。
行为保证:
- 对
event.input的修改影响实际的工具执行 - 后续的
tool_call处理器看到早期处理器所做的修改 - 修改后不执行重新验证
tool_call的返回值仅控制是否阻止,通过{ block: true, reason?: string }
import { isToolCallEventType } from "@earendil-works/pi-coding-agent";
pi.on("tool_call", async (event, ctx) => {
// event.toolName - "bash"、"read"、"write"、"edit" 等
// event.toolCallId
// event.input - 工具参数(可修改)
// 内置工具:不需要类型参数
if (isToolCallEventType("bash", event)) {
// event.input 是 { command: string; timeout?: number }
event.input.command = `source ~/.profile\n${event.input.command}`;
if (event.input.command.includes("rm -rf")) {
return { block: true, reason: "危险命令" };
}
}
if (isToolCallEventType("read", event)) {
// event.input 是 { path: string; offset?: number; limit?: number }
console.log(`正在读取: ${event.input.path}`);
}
});自定义工具输入的类型化 TypeScript custom tool input
自定义工具应导出其输入类型:
// my-extension.ts
export type MyToolInput = Static<typeof myToolSchema>;使用带显式类型参数的 isToolCallEventType:
import { isToolCallEventType } from "@earendil-works/pi-coding-agent";
import type { MyToolInput } from "my-extension";
pi.on("tool_call", (event) => {
if (isToolCallEventType<"my_tool", MyToolInput>("my_tool", event)) {
event.input.action; // 已类型化
}
});tool_result
在工具执行完成后、tool_execution_end 以及最终的 tool result 消息事件发送之前触发。可以修改结果。
在并行工具模式下,tool_result 和 tool_execution_end 可能按工具完成顺序交错,而最终的 toolResult 消息事件仍在之后按助手源顺序发送。
tool_result 处理器像中间件一样链接:
- 处理器按扩展加载顺序运行
- 每个处理器看到前一个处理器更改后的最新结果
- 处理器可以返回部分修补(
content、details或isError);省略的字段保持其当前值
使用 ctx.signal 在处理器内部进行嵌套的异步工作。这让 Esc 键可以取消由扩展启动的模型调用、fetch() 和其他支持中止的操作。
import { isBashToolResult } from "@earendil-works/pi-coding-agent";
pi.on("tool_result", async (event, ctx) => {
// event.toolName、event.toolCallId、event.input
// event.content、event.details、event.isError
if (isBashToolResult(event)) {
// event.details 类型为 BashToolDetails
}
const response = await fetch("https://example.com/summarize", {
method: "POST",
body: JSON.stringify({ content: event.content }),
signal: ctx.signal,
});
// 修改结果:
return { content: [...], details: {...}, isError: false };
});用户 Bash 事件 User Bash Events
user_bash
当用户执行 ! 或 !! 命令时触发。可以拦截。
import { createLocalBashOperations } from "@earendil-works/pi-coding-agent";
pi.on("user_bash", (event, ctx) => {
// event.command - bash 命令
// event.excludeFromContext - 如果使用 !! 前缀则为 true
// event.cwd - 工作目录
// 选项 1:提供自定义操作(例如 SSH)
return { operations: remoteBashOps };
// 选项 2:包装 pi 的内置本地 bash 后端
const local = createLocalBashOperations();
return {
operations: {
exec(command, cwd, options) {
return local.exec(`source ~/.profile\n${command}`, cwd, options);
}
}
};
// 选项 3:完全替换——直接返回结果
return { result: { output: "...", exitCode: 0, cancelled: false, truncated: false } };
});输入事件 Input Events
input
在收到用户输入后、扩展命令检查之后、技能和模板展开之前触发。该事件看到原始输入文本,因此 /skill:foo 和 /template 尚未展开。
处理顺序:
- 先检查扩展命令(
/cmd)——找到则运行处理器并跳过输入事件 input事件触发——可以拦截、转换或处理- 如果未处理:技能命令(
/skill:name)展开为技能内容 - 如果未处理:提示模板(
/template)展开为模板内容 - 代理处理开始(
before_agent_start等)
pi.on("input", async (event, ctx) => {
// event.text - 原始输入(在技能/模板展开之前)
// event.images - 附加的图像(如果有)
// event.source - "interactive"(键入)、"rpc"(API)或 "extension"(通过 sendUserMessage)
// event.streamingBehavior - "steer" | "followUp" | undefined
// undefined 表示空闲,"steer" 表示流中断,"followUp" 表示排队等待代理完成的消息
// 转换:在展开前重写输入
if (event.text.startsWith("?quick "))
return { action: "transform", text: `简要回答: ${event.text.slice(7)}` };
// 处理:无需 LLM 响应(扩展显示自己的反馈)
if (event.text === "ping") {
ctx.ui.notify("pong", "info");
return { action: "handled" };
}
// 按来源路由:跳过扩展注入的消息的处理
if (event.source === "extension") return { action: "continue" };
// 在展开前拦截技能命令
if (event.text.startsWith("/skill:")) {
// 可以转换、阻止或让其通过
}
return { action: "continue" }; // 默认:传递到展开
});结果:
continue- 不变地传递(如果处理器未返回任何内容,则为此默认值)transform- 修改文本/图像,然后继续展开handled- 完全跳过代理(第一个返回此值的处理器胜出)
转换跨处理器链接。有关支持 streamingBehavior 感知路由的示例,请参见 input-transform.ts 和 input-transform-streaming.ts。
ExtensionContext
所有处理器都接收 ctx: ExtensionContext。
ctx.ui
用于用户交互的 UI 方法。详情请参见 自定义 UI Custom UI。
ctx.mode
当前运行模式:"tui"、"rpc"、"json" 或 "print"。使用 ctx.mode === "tui" 来保护仅终端的功能,如 custom()、组件工厂、终端输入和直接 TUI 渲染。
ctx.hasUI
在 TUI 和 RPC 模式下为 true。在打印模式(-p)和 JSON 模式下为 false。使用此标志保护对话框方法(select、confirm、input、editor)和即发即弃方法(notify、setStatus、setWidget、setTitle、setEditorText),这些方法在 TUI 和 RPC 模式下都有效。在 RPC 模式下,某些 TUI 特定的方法是无操作或返回默认值(参见 rpc.md)。
ctx.cwd
当前工作目录。
在构造项目本地配置路径时使用 CONFIG_DIR_NAME 而不是硬编码 .pi。重新品牌的分发可能使用不同的配置目录名称。
import { CONFIG_DIR_NAME, type ExtensionAPI } from "@earendil-works/pi-coding-agent";
import { join } from "node:path";
export default function (pi: ExtensionAPI) {
pi.on("session_start", (_event, ctx) => {
const projectConfigPath = join(ctx.cwd, CONFIG_DIR_NAME, "my-extension.json");
// ...
});
}ctx.isProjectTrusted()
返回项目本地信任是否对当前会话上下文生效。这包括临时信任决定和 CLI 信任覆盖,而不仅仅是全局信任存储中的已保存决定。
在读取仅应针对受信任项目生效的项目本地扩展配置之前使用此方法。
ctx.sessionManager
对会话状态的只读访问。有关完整的 SessionManager API 和条目类型,请参见 Session Format。
对于 tool_call,此状态在处理程序运行之前通过当前助手消息同步。在并行工具执行模式下,仍不能保证包含来自同一助手消息的兄弟工具结果。
ctx.sessionManager.getEntries() // 所有条目
ctx.sessionManager.getBranch() // 当前分支
ctx.sessionManager.buildContextEntries() // 应用压缩后的活动分支条目
ctx.sessionManager.getLeafId() // 当前叶子条目 ID
ctx.modelRegistry / ctx.model
访问模型和 API 密钥。
ctx.signal
当前的代理中止信号,如果没有活跃的代理轮次则为 undefined。
将此信号用于扩展处理器启动的受中止感知的嵌套工作,例如:
fetch(..., { signal: ctx.signal })- 接受
signal的模型调用 - 接受
AbortSignal的文件或进程辅助函数
ctx.signal 在活跃轮次事件期间通常已定义,例如 tool_call、tool_result、message_update 和 turn_end。
在空闲或非轮次上下文中通常为 undefined,例如会话事件、扩展命令和 pi 空闲时触发的快捷键。
pi.on("tool_result", async (event, ctx) => {
const response = await fetch("https://example.com/api", {
method: "POST",
body: JSON.stringify(event),
signal: ctx.signal,
});
const data = await response.json();
return { details: data };
});ctx.isIdle() / ctx.abort() / ctx.hasPendingMessages()
控制流辅助方法。当 Pi 正在处理代理运行、自动重试、自动压缩重试或排队的后续消息时,ctx.isIdle() 返回 false。
ctx.shutdown()
请求优雅关闭 pi。
- 交互模式: 延迟到代理空闲后(在处理完所有排队的 steer 和 follow-up 消息后)。
- RPC 模式: 延迟到下一个空闲状态(完成当前命令响应后,等待下一个命令时)。
- 打印模式: 无操作。进程在所有提示处理完毕后自动退出。
在退出前向所有扩展发送 session_shutdown 事件。在所有上下文中可用(事件处理器、工具、命令、快捷键)。
pi.on("tool_call", (event, ctx) => {
if (isFatal(event.input)) {
ctx.shutdown();
}
});ctx.getContextUsage()
返回当前活动模型的上下文使用情况。在可用时使用最后一次助手使用量,然后估算剩余令牌数。
const usage = ctx.getContextUsage();
if (usage && usage.tokens > 100_000) {
// ...
}ctx.compact()
触发压缩而不等待完成。使用 onComplete 和 onError 进行后续操作。
ctx.compact({
customInstructions: "关注最近的更改",
onComplete: (result) => {
ctx.ui.notify("压缩完成", "info");
},
onError: (error) => {
ctx.ui.notify(`压缩失败: ${error.message}`, "error");
},
});ctx.getSystemPrompt()
返回 Pi 当前的系统提示字符串。
- 在
before_agent_start期间,反映了当前轮次到目前为止的链接系统提示更改。 - 不包括后来的
context消息修改。 - 不包括
before_provider_request载荷重写。 - 如果在你的扩展之后加载了其他扩展,它们仍然可以更改最终发送的内容。
pi.on("before_agent_start", (event, ctx) => {
const prompt = ctx.getSystemPrompt();
console.log(`系统提示长度: ${prompt.length}`);
});ExtensionCommandContext
命令处理器接收 ExtensionCommandContext,它扩展了 ExtensionContext 并包含会话控制方法。这些仅在命令中可用,因为如果从事件处理器调用它们可能会导致死锁。
ctx.getSystemPromptOptions()
返回 Pi 当前用于构建系统提示的基础输入。
const options = ctx.getSystemPromptOptions();
const contextPaths = options.contextFiles?.map((file) => file.path) ?? [];这与 before_agent_start 的 event.systemPromptOptions 具有相同的形状和可变性:自定义提示、活跃工具、工具片段、提示指导原则、追加的系统提示文本、cwd、已加载的上下文文件和已加载的技能。它可能包含完整的上下文文件内容,因此请将其视为敏感的扩展本地数据,避免通过命令列表、日志或自动完成元数据暴露。
这报告当前的基础提示输入。它不包括每次轮次的 before_agent_start 链接系统提示更改、后来的 context 事件消息修改或 before_provider_request 载荷重写。
ctx.waitForIdle()
等待代理完全安定,包括自动重试、自动压缩重试和排队的后续消息:
pi.registerCommand("my-cmd", {
handler: async (args, ctx) => {
await ctx.waitForIdle();
// 代理现在空闲,可以安全地修改会话
},
});ctx.newSession(options?)
创建新会话:
const parentSession = ctx.sessionManager.getSessionFile();
const kickoff = "在替换会话中继续";
const result = await ctx.newSession({
parentSession,
setup: async (sm) => {
sm.appendMessage({
role: "user",
content: [{ type: "text", text: "来自上一会话的上下文..." }],
timestamp: Date.now(),
});
},
withSession: async (ctx) => {
// 在此处仅使用替换会话的 ctx。
await ctx.sendUserMessage(kickoff);
},
});
if (result.cancelled) {
// 某个扩展取消了新会话
}选项:
parentSession:要在新会话头中记录的父会话文件setup:在withSession运行之前修改新会话的SessionManagerwithSession:针对新的替换会话上下文运行切换后工作。不要使用捕获的旧pi/ 命令ctx;请参见 会话替换生命周期和陷阱 Session replacement lifecycle and footguns。
ctx.fork(entryId, options?)
从特定条目分支,创建新的会话文件:
const result = await ctx.fork("entry-id-123", {
withSession: async (ctx) => {
// 在此处仅使用替换会话的 ctx。
ctx.ui.notify("现在在分支会话中", "info");
},
});
if (result.cancelled) {
// 某个扩展取消了分支
}
const cloneResult = await ctx.fork("entry-id-456", { position: "at" });
if (cloneResult.cancelled) {
// 某个扩展取消了克隆
}选项:
position:"before"(默认)在选定的用户消息之前分支,将该提示恢复到编辑器中position:"at"复制通过选定条目的活动路径,而不恢复编辑器文本withSession:针对新的替换会话上下文运行切换后工作。不要使用捕获的旧pi/ 命令ctx;请参见 会话替换生命周期和陷阱 Session replacement lifecycle and footguns。
ctx.navigateTree(targetId, options?)
导航到会话树中的不同点:
const result = await ctx.navigateTree("entry-id-456", {
summarize: true,
customInstructions: "关注错误处理更改",
replaceInstructions: false, // true = 完全替换默认提示
label: "review-checkpoint",
});选项:
summarize:是否生成废弃分支的摘要customInstructions:摘要器的自定义指令replaceInstructions:如果为 true,customInstructions替换默认提示而不是追加label:要附加到分支摘要条目(如果不摘要则附加到目标条目)的标签
ctx.switchSession(sessionPath, options?)
切换到不同的会话文件:
const result = await ctx.switchSession("/path/to/session.jsonl", {
withSession: async (ctx) => {
await ctx.sendUserMessage("在替换会话中继续工作");
},
});
if (result.cancelled) {
// 某个扩展通过 session_before_switch 取消了切换
}选项:
withSession:针对新的替换会话上下文运行切换后工作。不要使用捕获的旧pi/ 命令ctx;请参见 会话替换生命周期和陷阱 Session replacement lifecycle and footguns。
要发现可用会话,使用静态方法 SessionManager.list() 或 SessionManager.listAll():
import { SessionManager } from "@earendil-works/pi-coding-agent";
pi.registerCommand("switch", {
description: "切换到另一个会话",
handler: async (args, ctx) => {
const sessions = await SessionManager.list(ctx.cwd);
if (sessions.length === 0) return;
const choice = await ctx.ui.select(
"选择会话:",
sessions.map(s => s.file),
);
if (choice) {
await ctx.switchSession(choice, {
withSession: async (ctx) => {
ctx.ui.notify("已切换会话", "info");
},
});
}
},
});会话替换生命周期和陷阱 Session replacement lifecycle and footguns
withSession 接收一个新鲜的 ReplacedSessionContext,它扩展了 ExtensionCommandContext,并绑定了针对替换会话的异步 sendMessage() 和 sendUserMessage() 辅助方法。
生命周期和陷阱:
withSession仅在旧会话已发送session_shutdown、旧运行时已拆除、替换会话已重新绑定、并且新的扩展实例已经收到session_start之后才运行。- 回调仍然在原始闭包中执行,而不是在新的扩展实例内部。这意味着在
withSession启动之前,你的旧扩展实例可能已经运行了其关闭清理。 - 捕获的旧
pi/ 旧命令ctx会话绑定对象在替换后已过期,使用时会抛出错误。对于会话绑定的工作,仅使用传递给withSession的ctx。 - 之前提取的原始对象仍然是你的责任。例如,如果你在替换前捕获了
const sm = ctx.sessionManager,则sm仍然是旧的SessionManager对象。替换后不要重用它。 withSession中的代码应假定由你的session_shutdown处理器使其无效的任何状态已经消失。仅捕获那些能干净地跨越关闭状态的普通数据,例如字符串、ID 和序列化配置。
安全模式:
pi.registerCommand("handoff", {
handler: async (_args, ctx) => {
const kickoff = "从替换会话继续";
await ctx.newSession({
withSession: async (ctx) => {
await ctx.sendUserMessage(kickoff);
},
});
},
});不安全模式:
pi.registerCommand("handoff", {
handler: async (_args, ctx) => {
const oldSessionManager = ctx.sessionManager;
await ctx.newSession({
withSession: async (_ctx) => {
// 旧的过期对象:不要这样做
oldSessionManager.getSessionFile();
pi.sendUserMessage("错误");
},
});
},
});ctx.reload()
运行与 /reload 相同的重载流程。
pi.registerCommand("reload-runtime", {
description: "重载扩展、技能、提示、主题和上下文文件",
handler: async (_args, ctx) => {
await ctx.reload();
return;
},
});重要行为:
await ctx.reload()为当前扩展运行时发送session_shutdown- 然后重新加载资源并以
reason: "reload"发送session_start和以"reload"原因发送resources_discover - 当前正在运行的命令处理器仍在旧的调用帧中继续
await ctx.reload()之后的代码仍从重载前的版本运行await ctx.reload()之后的代码不得假设旧的内存中扩展状态仍然有效- 处理器返回后,未来的命令/事件/工具调用使用新的扩展版本
为了可预测的行为,将重载视为该处理器的终止点(await ctx.reload(); return;)。
工具使用 ExtensionContext 运行,因此不能直接调用 ctx.reload()。使用命令作为重载入口点,然后暴露一个工具将该命令作为后续用户消息排队。
LLM 可调用以触发重载的工具示例:
import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
import { Type } from "typebox";
export default function (pi: ExtensionAPI) {
pi.registerCommand("reload-runtime", {
description: "重载扩展、技能、提示、主题和上下文文件",
handler: async (_args, ctx) => {
await ctx.reload();
return;
},
});
pi.registerTool({
name: "reload_runtime",
label: "Reload Runtime",
description: "重载扩展、技能、提示、主题和上下文文件",
parameters: Type.Object({}),
async execute() {
pi.sendUserMessage("/reload-runtime", { deliverAs: "followUp" });
return {
content: [{ type: "text", text: "已将 /reload-runtime 排队为后续命令。" }],
};
},
});
}ExtensionAPI 方法 ExtensionAPI Methods
pi.on(event, handler)
订阅事件。有关事件类型和返回值,请参见 事件 Events。
pi.registerTool(definition)
注册可供 LLM 调用的自定义工具。详情请参见 自定义工具 Custom Tools。
pi.registerTool() 在扩展加载期间和启动后都可以工作。你可以在 session_start、命令处理器或其他事件处理器内部调用它。新工具在同一会话中立即可用,因此它们会出现在 pi.getAllTools() 中,并且无需 /reload 即可被 LLM 调用。
使用 pi.setActiveTools() 在运行时启用或禁用工具(包括动态添加的工具)。
使用 promptSnippet 将自定义工具选择进入 可用工具 Available tools 的一行条目,使用 promptGuidelines 在工具激活时向默认的 指导原则 Guidelines 部分追加工具特定的要点。
重要: promptGuidelines 要点被平坦地追加到 Guidelines 部分,没有工具名称前缀。每个指导原则必须指明其所指的工具——避免使用"在…时使用此工具",因为 LLM 无法判断"此"指的是哪个工具。请改为写"在…时使用 my_tool"。
完整的示例请参见 dynamic-tools.ts。
import { Type } from "typebox";
import { StringEnum } from "@earendil-works/pi-ai";
pi.registerTool({
name: "my_tool",
label: "My Tool",
description: "此工具的作用",
promptSnippet: "根据操作汇总或转换文本",
promptGuidelines: ["当用户要求汇总先前生成的文本时使用 my_tool。"],
parameters: Type.Object({
action: StringEnum(["list", "add"] as const),
text: Type.Optional(Type.String()),
}),
prepareArguments(args) {
// 可选的兼容性垫片。在模式验证之前运行。
// 返回当前模式形状,例如将旧字段折叠到现代参数对象中。
return args;
},
async execute(toolCallId, params, signal, onUpdate, ctx) {
// 流式进度
onUpdate?.({ content: [{ type: "text", text: "处理中..." }] });
return {
content: [{ type: "text", text: "完成" }],
details: { result: "..." },
};
},
// 可选:自定义渲染
renderCall(args, theme, context) { ... },
renderResult(result, options, theme, context) { ... },
});pi.sendMessage(message, options?)
将会话中注入自定义消息。自定义消息参与 LLM 上下文。对于不应发送给 LLM 的持久 TUI 内容,请使用 pi.appendEntry() 配合 pi.registerEntryRenderer()。
pi.sendMessage({
customType: "my-extension",
content: "消息文本",
display: true,
details: { ... },
}, {
triggerTurn: true,
deliverAs: "steer",
});选项:
deliverAs- 传递模式:"steer"(默认)——在流式传输时排队。在当前助手轮次完成执行其工具调用后、下一次 LLM 调用前传递。"followUp"——等待代理完成。仅在代理没有更多工具调用时传递。"nextTurn"——排队等待下一个用户提示。不中断或触发任何操作。
triggerTurn: true——如果代理空闲,立即触发 LLM 响应。仅适用于"steer"和"followUp"模式(对"nextTurn"忽略)。
pi.sendUserMessage(content, options?)
向代理发送用户消息。与发送自定义消息的 sendMessage() 不同,此方法发送实际的用户消息,看起来就像用户键入的一样。始终触发轮次。
// 简单文本消息
pi.sendUserMessage("2+2 等于多少?");
// 带内容数组(文本 + 图像)
pi.sendUserMessage([
{ type: "text", text: "描述这张图片:" },
{ type: "image", source: { type: "base64", mediaType: "image/png", data: "..." } },
]);
// 流式传输期间——必须指定传递模式
pi.sendUserMessage("关注错误处理", { deliverAs: "steer" });
pi.sendUserMessage("然后总结一下", { deliverAs: "followUp" });选项:
deliverAs——当代理正在流式传输时必需:"steer"——排队等待在当前助手轮次完成执行其工具调用后传递"followUp"——等待代理完成所有工具
当不在流式传输时,消息立即发送并触发新轮次。当流式传输时未指定 deliverAs 会抛出错误。
完整的示例请参见 send-user-message.ts。
pi.appendEntry(customType, data?)
持久化扩展数据。自定义条目不参与 LLM 上下文。在交互模式下,当配合 pi.registerEntryRenderer() 使用时,它们也可以在聊天记录中渲染。
pi.appendEntry("my-state", { count: 42 });
pi.appendEntry("status-card", { title: "已索引文件", count: 17 });
// 在重载时恢复
pi.on("session_start", async (_event, ctx) => {
for (const entry of ctx.sessionManager.getEntries()) {
if (entry.type === "custom" && entry.customType === "my-state") {
// 从 entry.data 重建
}
}
});pi.setSessionName(name)
设置会话显示名称(在会话选择器中显示,而不是第一条消息)。
pi.setSessionName("重构认证模块");pi.getSessionName()
获取当前会话名称(如果已设置)。
const name = pi.getSessionName();
if (name) {
console.log(`会话: ${name}`);
}pi.setLabel(entryId, label)
设置或清除条目标签。标签是用于书签和导航的用户定义标记(在 /tree 选择器中显示)。
// 设置标签
pi.setLabel(entryId, "checkpoint-before-refactor");
// 清除标签
pi.setLabel(entryId, undefined);
// 通过 sessionManager 读取标签
const label = ctx.sessionManager.getLabel(entryId);标签在会话中持久化,能跨重启存活。使用它们标记对话树中的重要点(轮次、检查点)。
pi.registerCommand(name, options)
注册命令。
如果多个扩展注册了相同的命令名称,pi 会保留所有扩展,并按加载顺序分配数字调用后缀,例如 /review:1 和 /review:2。
pi.registerCommand("stats", {
description: "显示会话统计信息",
handler: async (args, ctx) => {
const count = ctx.sessionManager.getEntries().length;
ctx.ui.notify(`${count} 个条目`, "info");
}
});可选:为 /command ... 添加参数自动完成:
import type { AutocompleteItem } from "@earendil-works/pi-tui";
pi.registerCommand("deploy", {
description: "部署到环境",
getArgumentCompletions: (prefix: string): AutocompleteItem[] | null => {
const envs = ["dev", "staging", "prod"];
const items = envs.map((e) => ({ value: e, label: e }));
const filtered = items.filter((i) => i.value.startsWith(prefix));
return filtered.length > 0 ? filtered : null;
},
handler: async (args, ctx) => {
ctx.ui.notify(`正在部署: ${args}`, "info");
},
});pi.getCommands()
获取当前会话中可通过 prompt 调用的斜杠命令。包括扩展命令、提示模板和技能命令。
该列表匹配 RPC get_commands 排序:先是扩展,然后是模板,最后是技能。
const commands = pi.getCommands();
const bySource = commands.filter((command) => command.source === "extension");
const userScoped = commands.filter((command) => command.sourceInfo.scope === "user");每个条目具有以下形状:
{
name: string; // 不带前导斜杠的可调用命令名称。可能带有后缀如 "review:1"
description?: string;
source: "extension" | "prompt" | "skill";
sourceInfo: {
path: string;
source: string;
scope: "user" | "project" | "temporary";
origin: "package" | "top-level";
baseDir?: string;
};
}使用 sourceInfo 作为规范的来源字段。不要从命令名称或临时路径解析推断所有权。
内置交互式命令(如 /model 和 /settings)不包含在此处。它们仅在交互模式下处理,如果通过 prompt 发送则不会执行。
pi.registerMessageRenderer(customType, renderer)
为具有你的 customType 的自定义消息注册自定义 TUI 渲染器。自定义消息通过 pi.sendMessage() 创建并参与 LLM 上下文。请参见 自定义 UI Custom UI。
pi.registerEntryRenderer(customType, renderer)
为具有你的 customType 的自定义条目注册自定义 TUI 渲染器。自定义条目通过 pi.appendEntry() 创建且不参与 LLM 上下文。
import { Box, Text } from "@earendil-works/pi-tui";
pi.registerEntryRenderer("status-card", (entry, { expanded }, theme) => {
const data = entry.data as { title: string; count: number };
const box = new Box(1, 1, (text) => theme.bg("customMessageBg", text));
box.addChild(new Text(`${theme.bold(data.title)}: ${data.count}`));
if (expanded) {
box.addChild(new Text(theme.fg("dim", JSON.stringify(data, null, 2))));
}
return box;
});
pi.appendEntry("status-card", { title: "已索引文件", count: 17 });pi.registerShortcut(shortcut, options)
注册键盘快捷键。有关快捷键格式和内置键绑定,请参见 keybindings.md。
pi.registerShortcut("ctrl+shift+p", {
description: "切换计划模式",
handler: async (ctx) => {
ctx.ui.notify("已切换!");
},
});pi.registerFlag(name, options)
注册 CLI 标志。
pi.registerFlag("plan", {
description: "以计划模式启动",
type: "boolean",
default: false,
});
// 检查值
if (pi.getFlag("plan")) {
// 计划模式已启用
}pi.exec(command, args, options?)
执行 shell 命令。
const result = await pi.exec("git", ["status"], { signal, timeout: 5000 });
// result.stdout、result.stderr、result.code、result.killed
pi.getActiveTools() / pi.getAllTools() / pi.setActiveTools(names)
管理活跃工具。这对内置工具和动态注册的工具都适用。pi.getActiveTools() 以 string[] 形式返回活跃工具名称;pi.getAllTools() 返回所有已配置工具的元数据。
const active = pi.getActiveTools(); // ["read", "bash", ...]
const all = pi.getAllTools();
// all = [{
// name: "read",
// description: "读取文件内容...",
// parameters: ...,
// promptGuidelines: ["使用 read 来检查文件,而不是 cat 或 sed。"],
// sourceInfo: { path: "<builtin:read>", source: "builtin", scope: "temporary", origin: "top-level" }
// }, ...]
const builtinTools = all.filter((t) => t.sourceInfo.source === "builtin");
const extensionTools = all.filter((t) => t.sourceInfo.source !== "builtin" && t.sourceInfo.source !== "sdk");
pi.setActiveTools([...new Set([...active, "my_custom_tool"])]); // 保留当前工具并启用 my_custom_tool
pi.setActiveTools(["read", "bash"]); // 切换到只读
pi.getAllTools() 返回 name、description、parameters、promptGuidelines 和 sourceInfo。
典型的 sourceInfo.source 值:
builtin用于内置工具sdk用于通过createAgentSession({ customTools })传递的工具- 扩展来源元数据用于由扩展注册的工具
pi.setModel(model)
设置当前模型。如果没有可用于该模型的 API 密钥,则返回 false。有关配置自定义模型,请参见 models.md。
const model = ctx.modelRegistry.find("anthropic", "claude-sonnet-4-5");
if (model) {
const success = await pi.setModel(model);
if (!success) {
ctx.ui.notify("此模型没有可用的 API 密钥", "error");
}
}pi.getThinkingLevel() / pi.setThinkingLevel(level)
获取或设置思考级别。级别会被限制到模型能力(非推理模型始终使用 “off”)。更改会触发 thinking_level_select。
const current = pi.getThinkingLevel(); // "off" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max"
pi.setThinkingLevel("high");pi.events
用于扩展间通信的共享事件总线:
pi.events.on("my:event", (data) => { ... });
pi.events.emit("my:event", { ... });pi.registerProvider(name, config)
动态注册或覆盖模型提供商。适用于代理、自定义端点或团队范围的模型配置。
在扩展工厂函数期间进行的调用会被排队,并在运行器初始化时应用。之后进行的调用——例如来自用户设置流程的命令处理器——立即生效,无需 /reload。
动态提供商可以实现 refreshModels。Pi 在模型刷新时调用它,通过提供商同步发布返回的列表,并传递规范的认证/存储/网络/信号上下文。扩展决定是否通过 context.store 持久化目录;像 llama.cpp 这样的实时服务器可以忽略它。
// 使用自定义模型注册新提供商
pi.registerProvider("my-proxy", {
name: "My Proxy",
baseUrl: "https://proxy.example.com",
apiKey: "$PROXY_API_KEY", // 环境变量引用
api: "anthropic-messages",
models: [
{
id: "claude-sonnet-4-20250514",
name: "Claude 4 Sonnet (proxy)",
reasoning: false,
input: ["text", "image"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 200000,
maxTokens: 16384
}
]
});
// 注册实时 llama.cpp 目录而不持久化发现的模型
pi.registerProvider("llama.cpp", {
baseUrl: "http://localhost:8080/v1",
apiKey: "local",
api: "openai-completions",
async refreshModels({ signal }) {
const response = await fetch("http://localhost:8080/v1/models", { signal });
const { data } = await response.json();
return data.map(({ id }) => ({
id,
name: id,
reasoning: false,
input: ["text"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 128000,
maxTokens: 16384
}));
}
});
// 覆盖现有提供商的 baseUrl(保留所有模型)
pi.registerProvider("anthropic", {
baseUrl: "https://proxy.example.com"
});
// 注册支持 OAuth 的提供商以支持 /login
pi.registerProvider("corporate-ai", {
baseUrl: "https://ai.corp.com",
api: "openai-responses",
models: [...],
oauth: {
name: "Corporate AI (SSO)",
async login(callbacks) {
// 自定义 OAuth 流程
callbacks.onAuth({ url: "https://sso.corp.com/..." });
const code = await callbacks.onPrompt({ message: "输入代码:" });
return { refresh: code, access: code, expires: Date.now() + 3600000 };
},
async refreshToken(credentials) {
// 刷新逻辑
return credentials;
},
getApiKey(credentials) {
return credentials.access;
}
}
});配置选项:
name- 在/login等 UI 中显示的提供商名称。baseUrl- API 端点 URL。定义模型时必需。apiKey- API 密钥字面量、环境插值($ENV_VAR或${ENV_VAR})或前导!command。定义模型时必需(除非提供了oauth)。$$转义$,$!转义字面量!而不触发命令执行。api- API 类型:"anthropic-messages"、"openai-completions"、"openai-responses"等。headers- 要在请求中包含的自定义请求头。authHeader- 如果为 true,自动添加Authorization: Bearer请求头。models- 模型定义数组。如果提供,替换该提供商的所有现有模型。模型定义可以设置baseUrl来覆盖该模型的提供商端点。refreshModels- 异步动态发现回调。其返回的模型替换扩展提供的模型。仅当结果应持久化时使用限定作用域的context.store。oauth- 支持/login的 OAuth 提供商配置。提供时,该提供商出现在登录菜单中。streamSimple- 用于非标准 API 的自定义流实现。
有关高级主题,请参见 custom-provider.md:自定义流 API、OAuth 详情、模型定义参考。
pi.unregisterProvider(name)
移除之前注册的提供商及其模型。被该提供商覆盖的内置模型将被恢复。如果该提供商未注册,则无效果。
像 registerProvider 一样,在初始加载阶段之后调用时立即生效,因此无需 /reload。
pi.registerCommand("my-setup-teardown", {
description: "移除自定义代理提供商",
handler: async (_args, _ctx) => {
pi.unregisterProvider("my-proxy");
},
});状态管理 State Management
有状态的扩展应将其状态存储在工具结果 details 中,以支持正确的分支:
export default function (pi: ExtensionAPI) {
let items: string[] = [];
// 从会话重建状态
pi.on("session_start", async (_event, ctx) => {
items = [];
for (const entry of ctx.sessionManager.getBranch()) {
if (entry.type === "message" && entry.message.role === "toolResult") {
if (entry.message.toolName === "my_tool") {
items = entry.message.details?.items ?? [];
}
}
}
});
pi.registerTool({
name: "my_tool",
// ...
async execute(toolCallId, params, signal, onUpdate, ctx) {
items.push("新项目");
return {
content: [{ type: "text", text: "已添加" }],
details: { items: [...items] }, // 为重建而存储
};
},
});
}自定义工具 Custom Tools
通过 pi.registerTool() 注册可供 LLM 调用的工具。工具出现在系统提示中,并可以有自定义渲染。
使用 promptSnippet 在默认系统提示的 可用工具 Available tools 部分显示简短的一行条目。如果省略,自定义工具将被排除在该部分之外。
使用 promptGuidelines 向默认系统提示的 指导原则 Guidelines 部分添加工具特定的要点。这些要点仅在工具激活时包含(例如,在 pi.setActiveTools([...]) 之后)。
重要: promptGuidelines 要点被平坦地追加到 Guidelines 部分,没有工具名称前缀或分组。每个指导原则必须指明其所指的工具——避免使用"在…时使用此工具",因为 LLM 无法判断"此"指的是哪个工具。请改为写"在…时使用 my_tool"。
注意:某些模型是傻瓜,会在工具路径参数中包含 @ 前缀。内置工具在解析路径前会剥离前导的 @。如果你的自定义工具接受路径,也要规范化前导的 @。
如果你的自定义工具修改文件,使用 withFileMutationQueue() 使其参与与内置 edit 和 write 相同的按文件队列。这很重要,因为工具调用默认并行运行。没有队列,两个工具可能读取相同的旧文件内容,计算不同的更新,然后最后写入的那一个会覆盖另一个。
失败示例:你的自定义工具编辑 foo.ts 而内置 edit 在同一助手轮次中也更改了 foo.ts。如果你的工具不参与队列,两者都可能读取原始的 foo.ts,应用不同的更改,其中一个更改会丢失。
将真实的文件路径传递给 withFileMutationQueue(),而不是原始用户参数。先将其解析为绝对路径,相对于 ctx.cwd 或你工具的工作目录。对于现有文件,该辅助函数通过 realpath() 进行规范化,因此同一文件的符号链接别名共享一个队列。对于新文件,它会回退到解析后的绝对路径,因为还没有可 realpath() 的内容。
将整个修改窗口排队到该目标路径上。这包括读取-修改-写入逻辑,而不仅仅是最终的写入。
import { withFileMutationQueue } from "@earendil-works/pi-coding-agent";
import { mkdir, readFile, writeFile } from "node:fs/promises";
import { dirname, resolve } from "node:path";
async execute(_toolCallId, params, _signal, _onUpdate, ctx) {
const absolutePath = resolve(ctx.cwd, params.path);
return withFileMutationQueue(absolutePath, async () => {
await mkdir(dirname(absolutePath), { recursive: true });
const current = await readFile(absolutePath, "utf8");
const next = current.replace(params.oldText, params.newText);
await writeFile(absolutePath, next, "utf8");
return {
content: [{ type: "text", text: `已更新 ${params.path}` }],
details: {},
};
});
}工具定义 Tool Definition
import { Type } from "typebox";
import { StringEnum } from "@earendil-works/pi-ai";
import { Text } from "@earendil-works/pi-tui";
pi.registerTool({
name: "my_tool",
label: "My Tool",
description: "此工具的作用(展示给 LLM)",
promptSnippet: "列出或添加项目待办事项列表中的项目",
promptGuidelines: [
"当用户要求任务列表时,使用 my_tool 进行待办规划,而不是直接编辑文件。"
],
parameters: Type.Object({
action: StringEnum(["list", "add"] as const), // 使用 StringEnum 以获得 Google 兼容性
text: Type.Optional(Type.String()),
}),
prepareArguments(args) {
if (!args || typeof args !== "object") return args;
const input = args as { action?: string; oldAction?: string };
if (typeof input.oldAction === "string" && input.action === undefined) {
return { ...input, action: input.oldAction };
}
return args;
},
async execute(toolCallId, params, signal, onUpdate, ctx) {
// 检查是否已取消
if (signal?.aborted) {
return { content: [{ type: "text", text: "已取消" }] };
}
// 流式进度更新
onUpdate?.({
content: [{ type: "text", text: "处理中..." }],
details: { progress: 50 },
});
// 通过 pi.exec 执行命令(从扩展闭包捕获)
const result = await pi.exec("some-command", [], { signal });
// 返回结果
return {
content: [{ type: "text", text: "完成" }], // 发送给 LLM
details: { data: result }, // 用于渲染和状态
// 可选:当该批次中每个最终确定的工具结果也返回 terminate: true 时,
// 在此工具批次后停止。
terminate: true,
};
},
// 可选:自定义渲染
renderCall(args, theme, context) { ... },
renderResult(result, options, theme, context) { ... },
});发出错误信号: 要将工具执行标记为失败(在结果上设置 isError: true 并报告给 LLM),从 execute 中抛出错误。无论你在返回对象中包含什么属性,返回值都不会设置错误标志。
提前终止: 从 execute() 返回 terminate: true 以提示应在当前工具批次后跳过自动后续 LLM 调用。仅当该批次中每个最终确定的工具结果都是终止性的时,此设置才生效。参见 examples/extensions/structured-output.ts 了解代理在最终的格式化输出工具调用上结束的简单示例。
// 正确:抛出以发出错误信号
async execute(toolCallId, params) {
if (!isValid(params.input)) {
throw new Error(`无效输入: ${params.input}`);
}
return { content: [{ type: "text", text: "OK" }], details: {} };
}重要: 对于字符串枚举,使用 @earendil-works/pi-ai 中的 StringEnum。Type.Union/Type.Literal 在 Google 的 API 中不起作用。
参数准备: prepareArguments(args) 是可选的。如果定义,它在模式验证之前和 execute() 之前运行。当 pi 恢复存储的工具调用参数不再匹配当前模式的旧会话时,使用它来模拟旧版接受的输入形状。返回你想要针对 parameters 验证的对象。保持公共模式严格。不要仅仅为了让旧的已恢复会话工作而向 parameters 添加已弃用的兼容性字段。
示例:旧会话可能包含带有顶层 oldText 和 newText 的 edit 工具调用,而当前模式仅接受 edits: [{ oldText, newText }]。
pi.registerTool({
name: "edit",
label: "Edit",
description: "使用精确文本替换编辑单个文件",
parameters: Type.Object({
path: Type.String(),
edits: Type.Array(
Type.Object({
oldText: Type.String(),
newText: Type.String(),
}),
),
}),
prepareArguments(args) {
if (!args || typeof args !== "object") return args;
const input = args as {
path?: string;
edits?: Array<{ oldText: string; newText: string }>;
oldText?: unknown;
newText?: unknown;
};
if (typeof input.oldText !== "string" || typeof input.newText !== "string") {
return args;
}
return {
...input,
edits: [...(input.edits ?? []), { oldText: input.oldText, newText: input.newText }],
};
},
async execute(toolCallId, params, signal, onUpdate, ctx) {
// params 现在匹配当前模式
return {
content: [{ type: "text", text: `正在应用 ${params.edits.length} 个编辑块` }],
details: {},
};
},
});覆盖内置工具 Overriding Built-in Tools
扩展可以通过注册同名工具来覆盖内置工具(read、bash、edit、write、grep、find、ls)。交互模式会在发生这种情况时显示警告。
# 扩展的 read 工具替换内置的 read
pi -e ./tool-override.ts或者,使用 --no-builtin-tools 在没有任何内置工具的情况下启动,同时保持扩展工具启用:
# 无内置工具,仅扩展工具
pi --no-builtin-tools -e ./my-extension.ts完整的示例请参见 examples/extensions/tool-override.ts,其中使用日志记录和访问控制覆盖了 read。
渲染: 内置渲染器继承按插槽解析。执行覆盖和渲染覆盖是独立的。如果你的覆盖省略了 renderCall,则使用内置的 renderCall。如果你的覆盖省略了 renderResult,则使用内置的 renderResult。如果你的覆盖同时省略了两者,则自动使用内置渲染器(语法高亮、差异等)。这让你可以为日志记录或访问控制包装内置工具,而无需重新实现 UI。
提示元数据: promptSnippet 和 promptGuidelines 不从内置工具继承。如果你的覆盖应保留这些提示指令,请显式地在覆盖上定义它们。
你的实现必须匹配精确的结果形状,包括 details 类型。UI 和会话逻辑依赖于这些形状进行渲染和状态跟踪。
内置工具实现:
- read.ts -
ReadToolDetails - bash.ts -
BashToolDetails - edit.ts
- write.ts
- grep.ts -
GrepToolDetails - find.ts -
FindToolDetails - ls.ts -
LsToolDetails
远程执行 Remote Execution
内置工具支持可插拔操作,用于委派到远程系统(SSH、容器等):
import { createReadTool, createBashTool, type ReadOperations } from "@earendil-works/pi-coding-agent";
// 使用自定义操作创建工具
const remoteRead = createReadTool(cwd, {
operations: {
readFile: (path) => sshExec(remote, `cat ${path}`),
access: (path) => sshExec(remote, `test -r ${path}`).then(() => {}),
}
});
// 注册,在执行时检查标志
pi.registerTool({
...remoteRead,
async execute(id, params, signal, onUpdate, _ctx) {
const ssh = getSshConfig();
if (ssh) {
const tool = createReadTool(cwd, { operations: createRemoteOps(ssh) });
return tool.execute(id, params, signal, onUpdate);
}
return localRead.execute(id, params, signal, onUpdate);
},
});操作接口: ReadOperations、WriteOperations、EditOperations、BashOperations、LsOperations、GrepOperations、FindOperations
对于 user_bash,扩展可以重用 pi 的本地 shell 后端,通过 createLocalBashOperations(),而不是重新实现本地进程生成、shell 解析和进程树终止。
bash 工具还支持一个 spawn 钩子,用于在执行前调整命令、cwd 或 env:
import { createBashTool } from "@earendil-works/pi-coding-agent";
const bashTool = createBashTool(cwd, {
spawnHook: ({ command, cwd, env }) => ({
command: `source ~/.profile\n${command}`,
cwd: `/mnt/sandbox${cwd}`,
env: { ...env, CI: "1" },
}),
});完整的 SSH 示例请参见 examples/extensions/ssh.ts,包含 --ssh 标志。
输出截断 Output Truncation
工具必须截断其输出,以避免淹没 LLM 上下文。大型输出可能导致:
- 上下文溢出错误(提示过长)
- 压缩失败
- 模型性能下降
内置限制为 50KB(约10k令牌)和 2000行,以先达到者为准。使用导出的截断工具:
import {
truncateHead, // 保留前 N 行/字节(适用于文件读取、搜索结果)
truncateTail, // 保留后 N 行/字节(适用于日志、命令输出)
truncateLine, // 用省略号截断单行至 maxBytes
formatSize, // 人类可读的大小(例如 "50KB"、"1.5MB")
DEFAULT_MAX_BYTES, // 50KB
DEFAULT_MAX_LINES, // 2000
} from "@earendil-works/pi-coding-agent";
async execute(toolCallId, params, signal, onUpdate, ctx) {
const output = await runCommand();
// 应用截断
const truncation = truncateHead(output, {
maxLines: DEFAULT_MAX_LINES,
maxBytes: DEFAULT_MAX_BYTES,
});
let result = truncation.content;
if (truncation.truncated) {
// 将完整输出写入临时文件
const tempFile = writeTempFile(output);
// 告知 LLM 在哪里找到完整输出
result += `\n\n[输出已截断: ${truncation.outputLines} / ${truncation.totalLines} 行`;
result += ` (${formatSize(truncation.outputBytes)} / ${formatSize(truncation.totalBytes)}).`;
result += ` 完整输出已保存至: ${tempFile}]`;
}
return { content: [{ type: "text", text: result }] };
}关键点:
- 使用
truncateHead处理开头重要的内容(搜索结果、文件读取) - 使用
truncateTail处理结尾重要的内容(日志、命令输出) - 始终告知 LLM 输出何时被截断以及在哪里找到完整版本
- 在你的工具描述中记录截断限制
完整的示例请参见 examples/extensions/truncated-tool.ts,其中使用适当的截断包装了 rg (ripgrep)。
多个工具 Multiple Tools
一个扩展可以注册多个共享状态的工具:
export default function (pi: ExtensionAPI) {
let connection = null;
pi.registerTool({ name: "db_connect", ... });
pi.registerTool({ name: "db_query", ... });
pi.registerTool({ name: "db_close", ... });
pi.on("session_shutdown", async () => {
connection?.close();
});
}自定义渲染 Custom Rendering
工具可以提供 renderCall 和 renderResult 用于自定义 TUI 显示。有关完整的组件 API,请参见 tui.md;有关工具行如何组成,请参见 tool-execution.ts。
默认情况下,工具输出包装在一个处理内边距和背景的 Box 中。已定义的 renderCall 或 renderResult 必须返回一个 Component。如果某个插槽渲染器未定义,tool-execution.ts 会使用该插槽的回退渲染。
当工具应渲染自己的外壳而不是使用默认的 Box 时,设置 renderShell: "self"。这对于需要完全控制边框或背景行为的工具有用,例如在工具稳定后必须保持视觉稳定的大型预览。
pi.registerTool({
name: "my_tool",
label: "My Tool",
description: "自定义外壳示例",
parameters: Type.Object({}),
renderShell: "self",
async execute() {
return { content: [{ type: "text", text: "ok" }], details: undefined };
},
renderCall(args, theme, context) {
return new Text(theme.fg("accent", "我的自定义外壳"), 0, 0);
},
});renderCall 和 renderResult 各自接收一个 context 对象,包含:
args- 当前工具调用参数state- 跨renderCall和renderResult的共享行局部状态lastComponent- 该插槽之前返回的组件(如果有)invalidate()- 请求重新渲染此工具行toolCallId、cwd、executionStarted、argsComplete、isPartial、expanded、showImages、isError
使用 context.state 实现跨插槽的共享状态。当你想跨渲染重用和变更同一组件实例时,将插槽局部缓存放在返回的组件实例上。
renderCall
渲染工具调用或头部:
import { Text } from "@earendil-works/pi-tui";
renderCall(args, theme, context) {
const text = (context.lastComponent as Text | undefined) ?? new Text("", 0, 0);
let content = theme.fg("toolTitle", theme.bold("my_tool "));
content += theme.fg("muted", args.action);
if (args.text) {
content += " " + theme.fg("dim", `"${args.text}"`);
}
text.setText(content);
return text;
}renderResult
渲染工具结果或输出:
renderResult(result, { expanded, isPartial }, theme, context) {
if (isPartial) {
return new Text(theme.fg("warning", "处理中..."), 0, 0);
}
if (result.details?.error) {
return new Text(theme.fg("error", `错误: ${result.details.error}`), 0, 0);
}
let text = theme.fg("success", "✓ 完成");
if (expanded && result.details?.items) {
for (const item of result.details.items) {
text += "\n " + theme.fg("dim", item);
}
}
return new Text(text, 0, 0);
}如果某个插槽故意没有可见内容,返回一个空的 Component,例如空的 Container。
快捷键提示 Keybinding Hints
使用 keyHint() 显示尊重活跃快捷键配置的快捷键提示:
import { keyHint } from "@earendil-works/pi-coding-agent";
renderResult(result, { expanded }, theme, context) {
let text = theme.fg("success", "✓ 完成");
if (!expanded) {
text += ` (${keyHint("app.tools.expand", "展开")})`;
}
return new Text(text, 0, 0);
}可用函数:
keyHint(keybinding, description)- 格式化配置的快捷键 ID,例如"app.tools.expand"或"tui.select.confirm"keyText(keybinding)- 返回快捷键 ID 的原始配置键文本rawKeyHint(key, description)- 格式化原始键字符串
使用命名空间的快捷键 ID:
- 编码代理 ID 使用
app.*命名空间,例如app.tools.expand、app.editor.external、app.session.rename - 共享 TUI ID 使用
tui.*命名空间,例如tui.select.confirm、tui.select.cancel、tui.input.tab
有关快捷键 ID 和默认值的详尽列表,请参见 keybindings.md。keybindings.json 使用相同的命名空间 ID。
自定义编辑器和 ctx.ui.custom() 组件接收 keybindings: KeybindingsManager 作为注入参数。它们应直接使用注入的管理器,而不是调用 getKeybindings() 或 setKeybindings()。
最佳实践 Best Practices
- 使用带有内边距
(0, 0)的Text。默认的Box处理内边距。 - 使用
\n实现多行内容。 - 处理
isPartial以实现流式进度。 - 支持
expanded以按需显示详情。 - 保持默认视图紧凑。
- 在
renderResult中读取context.args,而不是将 args 复制到context.state中。 - 仅将必须在调用和结果插槽之间共享的数据放入
context.state。 - 当同一组件实例可以原地更新时,重用
context.lastComponent。 - 仅当默认的盒式外壳妨碍你时使用
renderShell: "self"。在自我外壳模式下,工具负责自己的边框、内边距和背景。
回退 Fallback
如果某个插槽渲染器未定义或抛出:
renderCall:显示工具名称renderResult:显示来自content的原始文本
动态工具加载 Dynamic Tool Loading
扩展可以注册许多工具,同时只保持少量初始工具活跃。然后工具可以在执行期间使用 pi.setActiveTools() 添加更多工具。Pi 检测纯加性的更改,在工具结果上记录新可用的工具名称,并在下一个模型请求前应用更新后的活跃集。
这适用于每个模型。支持原生延迟加载的模型保留稳定的提示前缀,并在工具结果位置加载新的定义。其他模型使用下面描述的回退。
生命周期如下:
- 使用
pi.registerTool()注册每个工具,使其出现在pi.getAllTools()中。 - 保持加载工具(如
search_tools)活跃,并将可搜索的工具保持为非活跃。 - 在加载器执行期间,调用
pi.setActiveTools([...currentTools, ...matchingTools])。更改必须是加性的:不要在同一调用中移除当前活跃的工具。 - Pi 记录哪些工具是在加载器的工具结果上添加的。
- 在下一个模型响应前,Pi 在支持时使用原生延迟加载暴露添加的定义,否则使用正常的活跃工具列表。
你不需要返回提供商特定的工具引用或将加载器标记为特殊的搜索工具。活跃工具更改就是信号。传递给 pi.setActiveTools() 的名称必须已经注册;未知名称被忽略。
支持原生延迟加载的模型
- Anthropic
- 模型: Sonnet、Opus、Fable 版本 4.5 或更新(不包括 Haiku)
- 原生表示: 延迟定义使用
defer_loading;加载点使用tool_reference内容。
- OpenAI
- 模型:
gpt-5.4及更新系列 - 原生表示: Pi 在加载点添加已完成的客户端
tool_search_call和tool_search_output项。
- 模型:
对于已验证的自定义模型或代理,可以通过在 anthropic-messages 上设置 compat.supportsToolReferences: true,或在 openai-responses 和 openai-codex-responses 上设置 compat.supportsToolSearch: true 来启用原生处理。除非端点和对应的模型接受相应的原生协议,否则请保持禁用。
回退行为
对于所有其他模型和提供商,动态激活仍然有效:Pi 在下一个请求上正常发送完整的当前活跃工具列表。模型可以调用新激活的工具,但添加其定义可能会使提供商的缓存提示前缀失效。
当活跃集不是纯加性的(例如,用一组工具替换另一组)时,Pi 也使用此安全回退。因此工具移除是可行的,但它们不使用延迟加载。
为了获得最佳的缓存行为,保持加载工具在整个会话中活跃,并添加工具而不是替换活跃集。还要注意,激活带有 promptSnippet 或 promptGuidelines 的工具会重建系统提示;该系统提示更改即使提供商支持延迟模式也可能使前缀失效。延迟加载的工具通常应依赖其工具 description,并省略仅活跃时的提示元数据。
搜索工具示例
以下扩展注册了两个可搜索的工具,将它们从初始活跃集中移除,并仅保留 search_tools 作为加载器。该示例使用简单的关键字匹配,但搜索实现可以使用 BM25、嵌入向量、远程目录或项目特定的路由。
import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
import { Type } from "typebox";
const SEARCHABLE_TOOL_NAMES = new Set(["lookup_weather", "search_issues"]);
export default function (pi: ExtensionAPI) {
pi.registerTool({
name: "lookup_weather",
label: "Lookup Weather",
description: "查找城市的当前天气",
parameters: Type.Object({ city: Type.String() }),
async execute(_toolCallId, params) {
return {
content: [{ type: "text", text: `${params.city} 的天气: 晴` }],
details: {},
};
},
});
pi.registerTool({
name: "search_issues",
label: "Search Issues",
description: "按关键字搜索项目问题",
parameters: Type.Object({ query: Type.String() }),
async execute(_toolCallId, params) {
return {
content: [{ type: "text", text: `未找到与 ${params.query} 匹配的开放问题` }],
details: {},
};
},
});
pi.registerTool({
name: "search_tools",
label: "Search Tools",
description: "搜索并启用与任务相关的工具",
promptSnippet: "当活跃工具无法执行任务时搜索额外工具",
promptGuidelines: [
"当任务需要当前不可用的能力时使用 search_tools。",
],
parameters: Type.Object({
query: Type.String({ description: "要搜索的能力或任务" }),
limit: Type.Optional(Type.Integer({ minimum: 1, maximum: 10 })),
}),
async execute(_toolCallId, params) {
const terms = params.query.toLowerCase().split(/[^a-z0-9]+/).filter(Boolean);
const matches = pi.getAllTools()
.filter((tool) => SEARCHABLE_TOOL_NAMES.has(tool.name))
.map((tool) => ({
tool,
score: terms.reduce(
(score, term) =>
score + (`${tool.name} ${tool.description}`.toLowerCase().includes(term) ? 1 : 0),
0,
),
}))
.filter((match) => match.score > 0)
.sort((a, b) => b.score - a.score)
.slice(0, params.limit ?? 3)
.map((match) => match.tool.name);
if (matches.length === 0) {
return {
content: [{ type: "text", text: `未找到与 "${params.query}" 匹配的工具` }],
details: { matches: [] },
};
}
const active = pi.getActiveTools();
const added = matches.filter((name) => !active.includes(name));
pi.setActiveTools([...new Set([...active, ...added])]);
return {
content: [{
type: "text",
text: added.length > 0
? `已加载工具: ${added.join(", ")}`
: `匹配工具已活跃: ${matches.join(", ")}`,
}],
details: { matches, added },
};
},
});
pi.on("session_start", () => {
// 保持可搜索工具已注册但初始为非活跃。保留内置工具
// 和其他扩展拥有的工具,并保持加载器本身活跃。
const initialTools = pi.getActiveTools().filter(
(name) => !SEARCHABLE_TOOL_NAMES.has(name),
);
pi.setActiveTools([...new Set([...initialTools, "search_tools"])]);
});
}当 search_tools 添加匹配时,模型在紧随其后的请求中收到该定义。在支持原生功能的模型上,该定义锚定在搜索结果之后,而不更改初始工具模式前缀。在其他模型上,它出现在同一后续请求的正常工具列表中。
自定义 UI Custom UI
扩展可以通过 ctx.ui 方法与用户交互,并自定义消息/工具的渲染方式。
有关自定义组件,请参见 tui.md,其中包含可复制粘贴的模式:
- 选择对话框 (SelectList)
- 可取消的异步操作 (BorderedLoader)
- 设置开关 (SettingsList)
- 状态指示器 (setStatus)
- 工作中的消息、可见性和指示器(
setWorkingMessage、setWorkingVisible、setWorkingIndicator) - 编辑器上方/下方的小部件 (setWidget)
- 在内置斜杠/路径完成之上叠加的自动完成提供商 (addAutocompleteProvider)
- 自定义页脚 (setFooter)
对话框 Dialogs
// 从选项中选择
const choice = await ctx.ui.select("选择一个:", ["A", "B", "C"]);
// 确认对话框
const ok = await ctx.ui.confirm("删除?", "此操作无法撤销");
// 文本输入
const name = await ctx.ui.input("名称:", "占位符");
// 多行编辑器
const text = await ctx.ui.editor("编辑:", "预填充文本");
// 通知(非阻塞)
ctx.ui.notify("完成!", "info"); // "info" | "warning" | "error"
带倒计时的定时对话框 Timed Dialogs with Countdown
对话框支持 timeout 选项,可通过实时倒计时显示自动关闭:
// 对话框显示"标题 (5s)" → "标题 (4s)" → ... → 到 0 时自动关闭
const confirmed = await ctx.ui.confirm(
"定时确认",
"此对话框将在 5 秒后自动取消。确认吗?",
{ timeout: 5000 }
);
if (confirmed) {
// 用户已确认
} else {
// 用户已取消或超时
}超时时的返回值:
select()返回undefinedconfirm()返回falseinput()返回undefined
使用 AbortSignal 手动关闭
要获得更多控制(例如区分超时和用户取消),使用 AbortSignal:
const controller = new AbortController();
const timeoutId = setTimeout(() => controller.abort(), 5000);
const confirmed = await ctx.ui.confirm(
"定时确认",
"此对话框将在 5 秒后自动取消。确认吗?",
{ signal: controller.signal }
);
clearTimeout(timeoutId);
if (confirmed) {
// 用户已确认
} else if (controller.signal.aborted) {
// 对话框超时
} else {
// 用户已取消(按 Escape 或选择"否")
}完整的示例请参见 examples/extensions/timed-confirm.ts。
小部件、状态和页脚 Widgets, Status, and Footer
// 页脚中的状态(持久化,直到清除)
ctx.ui.setStatus("my-ext", "处理中...");
ctx.ui.setStatus("my-ext", undefined); // 清除
// 工作中的加载器(在流式传输期间显示)
ctx.ui.setWorkingMessage("正在深入思考...");
ctx.ui.setWorkingMessage(); // 恢复默认
ctx.ui.setWorkingVisible(false); // 隐藏内置工作加载器行
ctx.ui.setWorkingVisible(true); // 显示内置工作加载器行
// 工作指示器(在流式传输期间显示)
ctx.ui.setWorkingIndicator({ frames: [ctx.ui.theme.fg("accent", "●")] }); // 静态点
ctx.ui.setWorkingIndicator({
frames: [
ctx.ui.theme.fg("dim", "·"),
ctx.ui.theme.fg("muted", "•"),
ctx.ui.theme.fg("accent", "●"),
ctx.ui.theme.fg("muted", "•"),
],
intervalMs: 120,
});
ctx.ui.setWorkingIndicator({ frames: [] }); // 隐藏指示器
ctx.ui.setWorkingIndicator(); // 恢复默认旋转器
// 编辑器上方的小部件(默认)
ctx.ui.setWidget("my-widget", ["第1行", "第2行"]);
// 编辑器下方的小部件
ctx.ui.setWidget("my-widget", ["第1行", "第2行"], { placement: "belowEditor" });
ctx.ui.setWidget("my-widget", (tui, theme) => new Text(theme.fg("accent", "自定义"), 0, 0));
ctx.ui.setWidget("my-widget", undefined); // 清除
// 自定义页脚(完全替换内置页脚)
ctx.ui.setFooter((tui, theme) => ({
render(width) { return [theme.fg("dim", "自定义页脚")]; },
invalidate() {},
}));
ctx.ui.setFooter(undefined); // 恢复内置页脚
// 终端标题
ctx.ui.setTitle("pi - my-project");
// 编辑器文本
ctx.ui.setEditorText("预填充文本");
const current = ctx.ui.getEditorText();
// 粘贴到编辑器(触发粘贴处理,包括对大内容的折叠)
ctx.ui.pasteToEditor("粘贴的内容");
// 在内置提供商之上叠加自定义自动完成行为
ctx.ui.addAutocompleteProvider((current) => ({
triggerCharacters: ["#"],
async getSuggestions(lines, line, col, options) {
const beforeCursor = (lines[line] ?? "").slice(0, col);
const match = beforeCursor.match(/(?:^|[ \t])#([^\s#]*)$/);
if (!match) {
return current.getSuggestions(lines, line, col, options);
}
return {
prefix: `#${match[1] ?? ""}`,
items: [{ value: "#2983", label: "#2983", description: "自动完成的扩展 API" }],
};
},
applyCompletion(lines, line, col, item, prefix) {
return current.applyCompletion(lines, line, col, item, prefix);
},
shouldTriggerFileCompletion(lines, line, col) {
return current.shouldTriggerFileCompletion?.(lines, line, col) ?? true;
},
}));
// 工具输出展开
const wasExpanded = ctx.ui.getToolsExpanded();
ctx.ui.setToolsExpanded(true);
ctx.ui.setToolsExpanded(wasExpanded);
// 自定义编辑器(vim 模式、emacs 模式等)
ctx.ui.setEditorComponent((tui, theme, keybindings) => new VimEditor(tui, theme, keybindings));
const currentEditor = ctx.ui.getEditorComponent();
ctx.ui.setEditorComponent((tui, theme, keybindings) =>
new WrappedEditor(tui, theme, keybindings, currentEditor?.(tui, theme, keybindings))
);
ctx.ui.setEditorComponent(undefined); // 恢复默认编辑器
// 主题管理(有关创建主题,请参见 themes.md)
const themes = ctx.ui.getAllThemes(); // [{ name: "dark", path: "/..." | undefined }, ...]
const lightTheme = ctx.ui.getTheme("light"); // 加载而不切换
const result = ctx.ui.setTheme("light"); // 按名称切换
if (!result.success) {
ctx.ui.notify(`失败: ${result.error}`, "error");
}
ctx.ui.setTheme(lightTheme!); // 或者按 Theme 对象切换
ctx.ui.theme.fg("accent", "样式化文本"); // 访问当前主题
自定义工作指示器帧按原样渲染。如果你想要颜色,请自行将其添加到帧字符串中,例如使用 ctx.ui.theme.fg(...)。
自动完成提供商 Autocomplete Providers
使用 ctx.ui.addAutocompleteProvider() 在内置斜杠命令和路径提供商之上叠加自定义自动完成逻辑。为自定义的自然触发字符(如 $)设置 triggerCharacters。
典型模式:
- 检查光标前的文本
- 当你的扩展特定语法匹配时返回你自己的建议
- 否则委托给
current.getSuggestions(...) - 除非你需要自定义插入行为,否则委托
applyCompletion(...)
pi.on("session_start", (_event, ctx) => {
ctx.ui.addAutocompleteProvider((current) => ({
triggerCharacters: ["#"],
async getSuggestions(lines, cursorLine, cursorCol, options) {
const line = lines[cursorLine] ?? "";
const beforeCursor = line.slice(0, cursorCol);
const match = beforeCursor.match(/(?:^|[ \t])#([^\s#]*)$/);
if (!match) {
return current.getSuggestions(lines, cursorLine, cursorCol, options);
}
return {
prefix: `#${match[1] ?? ""}`,
items: [
{ value: "#2983", label: "#2983", description: "注册自定义 @ 自动完成提供商的扩展 API" },
{ value: "#2753", label: "#2753", description: "重载过时资源设置" },
],
};
},
applyCompletion(lines, cursorLine, cursorCol, item, prefix) {
return current.applyCompletion(lines, cursorLine, cursorCol, item, prefix);
},
shouldTriggerFileCompletion(lines, cursorLine, cursorCol) {
return current.shouldTriggerFileCompletion?.(lines, cursorLine, cursorCol) ?? true;
},
}));
});完整的示例请参见 github-issue-autocomplete.ts,其中预加载了来自 gh issue list 的最新开放 GitHub 问题,并在本地进行过滤以实现快速的 #... 完成。它需要 GitHub CLI (gh) 和 GitHub 仓库检出。
自定义组件 Custom Components
对于复杂的 UI,使用 ctx.ui.custom()。这会暂时用你的组件替换编辑器,直到调用 done():
import { Text, Component } from "@earendil-works/pi-tui";
const result = await ctx.ui.custom<boolean>((tui, theme, keybindings, done) => {
const text = new Text("按 Enter 确认,按 Escape 取消", 1, 1);
text.onKey = (key) => {
if (key === "return") done(true);
if (key === "escape") done(false);
return true;
};
return text;
});
if (result) {
// 用户按了 Enter
}回调接收:
tui- TUI 实例(用于屏幕尺寸、焦点管理)theme- 用于样式设置的当前主题keybindings- 应用快捷键管理器(用于检查快捷键)done(value)- 调用以关闭组件并返回值
有关完整的组件 API,请参见 tui.md。
覆盖模式(实验性) Overlay Mode (Experimental)
传递 { overlay: true } 将组件渲染为现有内容之上的浮动模态框,而不清除屏幕:
const result = await ctx.ui.custom<string | null>(
(tui, theme, keybindings, done) => new MyOverlayComponent({ onClose: done }),
{ overlay: true }
);对于高级定位(锚点、边距、百分比、响应式可见性),传递 overlayOptions。使用 onHandle 以编程方式控制焦点或可见性:
const result = await ctx.ui.custom<string | null>(
(tui, theme, keybindings, done) => new MyOverlayComponent({ onClose: done }),
{
overlay: true,
overlayOptions: { anchor: "top-right", width: "50%", margin: 2 },
onHandle: (handle) => {
handle.focus(); // 聚焦此覆盖并将其带到视觉前面
// handle.unfocus({ target: editorComponent }); // 将输入释放到特定组件
// handle.setHidden(true/false); // 切换可见性
// handle.hide(); // 永久移除
}
}
);聚焦的可见覆盖可以在临时的非覆盖自定义 UI 关闭后重新夺回输入。如果你有意让另一个组件在覆盖保持可见时继续获得输入,调用 handle.unfocus({ target })。传递 { target: null } 释放覆盖而不聚焦另一个组件。
有关完整的 OverlayOptions 和 OverlayHandle API,请参见 tui.md;有关示例,请参见 overlay-qa-tests.ts。
自定义编辑器 Custom Editor
用自定义实现替换主输入编辑器(vim 模式、emacs 模式等):
import { CustomEditor, type ExtensionAPI } from "@earendil-works/pi-coding-agent";
import { matchesKey } from "@earendil-works/pi-tui";
class VimEditor extends CustomEditor {
private mode: "normal" | "insert" = "insert";
handleInput(data: string): void {
if (matchesKey(data, "escape") && this.mode === "insert") {
this.mode = "normal";
return;
}
if (this.mode === "normal" && data === "i") {
this.mode = "insert";
return;
}
super.handleInput(data); // 应用快捷键 + 文本编辑
}
}
export default function (pi: ExtensionAPI) {
pi.on("session_start", (_event, ctx) => {
ctx.ui.setEditorComponent((_tui, theme, keybindings) =>
new VimEditor(theme, keybindings)
);
});
}关键点:
- 扩展
CustomEditor(不是基础的Editor)以获得应用快捷键(Escape 中止、ctrl+d、模型切换) - 对于你不处理的按键,调用
super.handleInput(data) - 工厂从应用中接收
theme和keybindings - 使用
ctx.ui.getEditorComponent()在setEditorComponent()之前包装之前配置的自定义编辑器 - 传递
undefined恢复默认:ctx.ui.setEditorComponent(undefined)
要组合另一个已替换编辑器的扩展,在设置你的编辑器之前捕获之前的工厂:
const previous = ctx.ui.getEditorComponent();
ctx.ui.setEditorComponent((tui, theme, keybindings) =>
new MyEditor(tui, theme, keybindings, { base: previous?.(tui, theme, keybindings) })
);完整的示例(包含模式指示器)请参见 tui.md 模式 7。
消息和条目渲染 Message and Entry Rendering
为具有你的 customType 的消息注册自定义渲染器。对于应参与 LLM 上下文的内容使用消息渲染器:
import { Text } from "@earendil-works/pi-tui";
pi.registerMessageRenderer("my-extension", (message, options, theme) => {
const { expanded } = options;
let text = theme.fg("accent", `[${message.customType}] `);
text += message.content;
if (expanded && message.details) {
text += "\n" + theme.fg("dim", JSON.stringify(message.details, null, 2));
}
return new Text(text, 0, 0);
});消息通过 pi.sendMessage() 发送:
pi.sendMessage({
customType: "my-extension", // 匹配 registerMessageRenderer
content: "状态更新",
display: true, // 在 TUI 中显示
details: { ... }, // 在渲染器中可用
});对于不应发送给 LLM 的仅 TUI 内容,改为渲染自定义条目:
pi.registerEntryRenderer("my-card", (entry, options, theme) => {
return new Text(theme.fg("accent", JSON.stringify(entry.data)));
});
pi.appendEntry("my-card", { status: "done" });主题颜色 Theme Colors
所有渲染函数接收一个 theme 对象。有关创建自定义主题和完整调色板,请参见 themes.md。
// 前景色
theme.fg("toolTitle", text) // 工具名称
theme.fg("accent", text) // 高亮
theme.fg("success", text) // 成功(绿色)
theme.fg("error", text) // 错误(红色)
theme.fg("warning", text) // 警告(黄色)
theme.fg("muted", text) // 次要文本
theme.fg("dim", text) // 第三级文本
// 文本样式
theme.bold(text)
theme.italic(text)
theme.strikethrough(text)在自定义工具渲染器中使用语法高亮:
import { highlightCode, getLanguageFromPath } from "@earendil-works/pi-coding-agent";
// 使用显式语言高亮代码
const highlighted = highlightCode("const x = 1;", "typescript", theme);
// 从文件路径自动检测语言
const lang = getLanguageFromPath("/path/to/file.rs"); // "rust"
const highlighted = highlightCode(code, lang, theme);错误处理 Error Handling
- 扩展错误会被记录,代理继续运行
tool_call错误会阻止该工具(安全失败)- 工具
execute错误必须通过抛出异常来发出信号;抛出的错误会被捕获,以isError: true报告给 LLM,执行继续
模式行为 Mode Behavior
| 模式 Mode | ctx.mode | ctx.hasUI | 说明 Notes |
|---|---|---|---|
| 交互式 Interactive | "tui" | true | 带有终端渲染的完整 TUI |
RPC (--mode rpc) | "rpc" | true | 通过 JSON 协议的对话框和通知;custom() 返回 undefined。参见 rpc.md |
JSON (--mode json) | "json" | false | 事件流输出到 stdout;UI 方法为无操作 |
打印 Print (-p) | "print" | false | 扩展运行但不能提示 |
在 TUI 特定功能(custom()、组件工厂、终端输入)之前使用 ctx.mode === "tui"。在适用于 TUI 和 RPC 模式的对话框和通知方法之前使用 ctx.hasUI。
示例参考 Examples Reference
所有示例位于 examples/extensions/。
| 示例 Example | 说明 Description | 关键 API Key APIs |
|---|---|---|
| 工具 Tools | ||
hello.ts | 最小工具注册 | registerTool |
question.ts | 带用户交互的工具 | registerTool、ui.select |
questionnaire.ts | 多步骤向导工具 | registerTool、ui.custom |
todo.ts | 带持久化的有状态工具 | registerTool、appendEntry、renderResult、会话事件 |
dynamic-tools.ts | 启动后和命令期间注册工具 | registerTool、session_start、registerCommand |
structured-output.ts | 带 terminate: true 的最终格式化输出工具 | registerTool、终止性工具结果 |
truncated-tool.ts | 输出截断示例 | registerTool、truncateHead |
tool-override.ts | 覆盖内置 read 工具 | registerTool(与内置同名) |
| 命令 Commands | ||
pirate.ts | 每轮次修改系统提示 | registerCommand、before_agent_start |
summarize.ts | 对话摘要命令 | registerCommand、ui.custom |
handoff.ts | 跨提供商模型交接 | registerCommand、ui.editor、ui.custom |
qna.ts | 带自定义 UI 的问答 | registerCommand、ui.custom、setEditorText |
send-user-message.ts | 注入用户消息 | registerCommand、sendUserMessage |
reload-runtime.ts | 重载命令和 LLM 工具交接 | registerCommand、ctx.reload()、sendUserMessage |
shutdown-command.ts | 优雅关闭命令 | registerCommand、shutdown() |
| 事件与门控 Events & Gates | ||
permission-gate.ts | 阻止危险命令 | on("tool_call")、ui.confirm |
project-trust.ts | 从用户/全局或 CLI 扩展决定或推迟项目信任 | on("project_trust")、信任 UI、必需的信任结果 |
protected-paths.ts | 阻止对特定路径的写入 | on("tool_call") |
confirm-destructive.ts | 确认会话更改 | on("session_before_switch")、on("session_before_fork") |
dirty-repo-guard.ts | 在脏 git 仓库上发出警告 | on("session_before_*")、exec |
input-transform.ts | 转换用户输入 | on("input") |
input-transform-streaming.ts | 流感知的输入转换 | on("input")、streamingBehavior |
model-status.ts | 响应模型更改 | on("model_select")、setStatus |
provider-payload.ts | 检查载荷和提供商响应头 | on("before_provider_request")、on("after_provider_response") |
system-prompt-header.ts | 显示系统提示信息 | on("agent_start")、getSystemPrompt |
claude-rules.ts | 从文件加载规则 | on("session_start")、on("before_agent_start") |
prompt-customizer.ts | 使用 systemPromptOptions 添加上下文感知的工具指导 | on("before_agent_start")、BuildSystemPromptOptions |
file-trigger.ts | 文件监听器触发消息 | sendMessage |
| 压缩与会话 Compaction & Sessions | ||
custom-compaction.ts | 自定义压缩摘要 | on("session_before_compact") |
trigger-compact.ts | 手动触发压缩 | compact() |
git-checkpoint.ts | 在轮次时 git 暂存 | on("turn_start")、on("session_before_fork")、exec |
git-merge-and-resolve.ts | 获取、合并和解决冲突 | on("agent_end")、exec、sendUserMessage |
auto-commit-on-exit.ts | 关闭时提交 | on("session_shutdown")、exec |
| UI 组件 UI Components | ||
status-line.ts | 页脚状态指示器 | setStatus、会话事件 |
working-indicator.ts | 自定义流式工作指示器 | setWorkingIndicator、registerCommand |
github-issue-autocomplete.ts | 通过预加载 gh issue list 中的最新开放问题,在内置自动完成之上添加 #1234 问题完成 | addAutocompleteProvider、on("session_start")、exec |
custom-footer.ts | 完全替换页脚 | registerCommand、setFooter |
custom-header.ts | 替换启动头部 | on("session_start")、setHeader |
modal-editor.ts | Vim 风格模态编辑器 | setEditorComponent、CustomEditor |
rainbow-editor.ts | 自定义编辑器样式 | setEditorComponent |
widget-placement.ts | 编辑器上方/下方的小部件 | setWidget |
overlay-test.ts | 覆盖组件 | 带覆盖选项的 ui.custom |
overlay-qa-tests.ts | 全面覆盖测试 | ui.custom、所有覆盖选项 |
notify.ts | 简单通知 | ui.notify |
timed-confirm.ts | 带超时的对话框 | 带 timeout/signal 的 ui.confirm |
mac-system-theme.ts | 自动切换主题 | setTheme、exec |
| 复杂扩展 Complex Extensions | ||
plan-mode/ | 完整计划模式实现 | 所有事件类型、registerCommand、registerShortcut、registerFlag、setStatus、setWidget、sendMessage、setActiveTools |
preset.ts | 可保存的预设(模型、工具、思考) | registerCommand、registerShortcut、registerFlag、setModel、setActiveTools、setThinkingLevel、appendEntry |
tools.ts | 开关工具的 UI | registerCommand、setActiveTools、SettingsList、会话事件 |
| 远程与沙箱 Remote & Sandbox | ||
ssh.ts | SSH 远程执行 | registerFlag、on("user_bash")、on("before_agent_start")、工具操作 |
interactive-shell.ts | 持久 shell 会话 | on("user_bash") |
sandbox/ | 沙箱化工具执行 | 工具操作 |
gondolin/ | 将内置工具和 ! 命令路由到 Gondolin 微 VM | 工具操作、内置工具覆盖、on("user_bash") |
subagent/ | 生成子代理 | registerTool、exec |
| 游戏 Games | ||
snake.ts | 贪吃蛇游戏 | registerCommand、ui.custom、键盘处理 |
space-invaders.ts | 太空侵略者游戏 | registerCommand、ui.custom |
doom-overlay/ | 覆盖层中的 Doom | 带覆盖的 ui.custom |
| 提供商 Providers | ||
custom-provider-anthropic/ | 自定义 Anthropic 代理 | registerProvider |
custom-provider-gitlab-duo/ | GitLab Duo 集成 | 带 OAuth 的 registerProvider |
| 消息与通信 Messages & Communication | ||
message-renderer.ts | 自定义消息渲染 | registerMessageRenderer、sendMessage |
entry-renderer.ts | 仅 TUI 的自定义条目渲染 | registerEntryRenderer、appendEntry |
event-bus.ts | 扩展间事件 | pi.events |
| 会话元数据 Session Metadata | ||
session-name.ts | 为选择器命名会话 | setSessionName、getSessionName |
bookmark.ts | 为 /tree 书签标记条目 | setLabel |
| 其他 Misc | ||
inline-bash.ts | 工具调用中的内联 bash | on("tool_call") |
bash-spawn-hook.ts | 在执行前调整 bash 命令、cwd 和 env | createBashTool、spawnHook |
with-deps/ | 带 npm 依赖的扩展 | 包含 package.json 的包结构 |