Extensions(扩展)
本页面是 Pi 官方文档 的中文翻译。仅供学习参考。
Extensions 是 TypeScript 模块,用于扩展 Pi 的行为。扩展可以订阅生命周期事件、注册 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 检查点(每次交互前 stash,切换分支时恢复)
- 路径保护(阻止写入
.env、node_modules/ 等)
- 自定义压缩(以自定义方式总结对话)
- 对话摘要(参见
summarize.ts 示例)
- 交互式工具(问题、向导、自定义对话框)
- 有状态工具(待办列表、连接池)
- 外部集成(文件监听器、Webhook、CI 触发器)
- 等待期间的游戏(参见
snake.ts 示例)
参见 examples/extensions/ 获取可运行的实现。
目录
快速开始
创建文件 ~/.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: "问候",
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)标志测试:
扩展位置
安全性: 扩展以您的完整系统权限运行,可以执行任意代码。请仅从信任的来源安装。
扩展从以下位置自动发现:
通过 settings.json 添加额外路径:
{
"packages": [
"npm:@foo/[email protected]",
"git:github.com/user/repo@v1"
],
"extensions": [
"/path/to/local/extension.ts",
"/path/to/local/extension/dir"
]
}
要通过 npm 或 git 以 pi 包的形式分享扩展,请参见 packages.md。
可用导入
npm 依赖同样可用。在扩展旁边(或父目录中)添加 package.json,运行 npm install,导入语句会自动从 node_modules/ 解析。
对于通过 pi install(npm 或 git)安装的分发式 pi 包,运行时依赖必须放在 dependencies 中。包安装默认使用生产环境安装(npm install --omit=dev),因此 devDependencies 在运行时不可用;当配置了 npmCommand 时,git 包使用普通 install 以兼容包装器。
Node.js 内置模块(node:fs、node:path 等)也可用。
编写扩展
扩展导出一个默认的工厂函数,该函数接收 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() 排队的提供者注册刷新之前完成。
异步工厂函数
对一次性启动工作(如获取远程配置或动态发现可用模型)使用异步工厂。
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 中都可用。
扩展风格
单文件——最简单,适用于小型扩展:
~/.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/ 的导入会自动生效。
事件
生命周期概览
pi 启动
│
├─► session_start { reason: "startup" }
└─► resources_discover { reason: "startup" }
│
▼
用户发送提示 ─────────────────────────────────────────┐
│ │
├─► (先检查扩展命令,如匹配则绕过) │
├─► input(可以拦截、转换或处理) │
├─► (如未处理,进行 skill/模板扩展) │
├─► before_agent_start(可注入消息、修改系统提示) │
├─► agent_start │
├─► message_start / message_update / message_end │
│ │
│ ┌─── 回合(LLM 调用工具时重复) ───┐ │
│ │ │ │
│ ├─► turn_start │ │
│ ├─► context(可修改消息) │ │
│ ├─► before_provider_request(可检查或替换负载) │
│ ├─► after_provider_response(状态+标头,流消费前) │
│ │ │ │
│ │ LLM 响应,可能调用工具: │ │
│ │ ├─► tool_execution_start │ │
│ │ ├─► tool_call(可阻止) │ │
│ │ ├─► tool_execution_update │ │
│ │ ├─► tool_result(可修改) │ │
│ │ └─► tool_execution_end │ │
│ │ │ │
│ └─► turn_end │ │
│ │
└─► agent_end │
│
用户发送另一个提示 ◄────────────────────────────────────────┘
/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" }
/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
资源事件
resources_discover
在 session_start 后触发,用于让扩展贡献额外的 skill、prompt 和主题路径。
启动路径使用 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"],
};
});
会话事件
关于会话存储内部细节和 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_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, signal } = event;
// 取消:
return { cancel: true };
// 自定义摘要:
return {
compaction: {
summary: "...",
firstKeptEntryId: preparation.firstKeptEntryId,
tokensBefore: preparation.tokensBefore,
}
};
});
pi.on("session_compact", async (event, ctx) => {
// event.compactionEntry - 保存的压缩
// event.fromExtension - 是否由扩展提供
});
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
在扩展运行时被销毁前触发。
pi.on("session_shutdown", async (event, ctx) => {
// event.reason - "quit" | "reload" | "new" | "resume" | "fork"
// event.targetSessionFile - 会话替换流程的目标会话
// 清理、保存状态等
});
Agent 事件
before_agent_start
在用户提交提示后、Agent 循环开始前触发。可以注入消息和/或修改系统提示。
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 - 已加载的 skill
return {
// 注入持久消息(存储在会话中,发送给 LLM)
message: {
customType: "my-extension",
content: "给 LLM 的额外上下文",
display: true,
},
// 为此轮替换系统提示(在扩展间链式拼接)
systemPrompt: event.systemPrompt + "\n\n此轮的额外指令...",
};
});
systemPromptOptions 字段为扩展提供了与 Pi 构建系统提示相同的结构化数据。这使您可以检查 Pi 加载的内容——自定义提示、准则、工具片段、上下文文件、skill——而无需重新发现资源或重新解析标志。当您的扩展需要对系统提示进行深入、有根据的修改,同时尊重用户提供的配置时使用此字段。
在 before_agent_start 内部,event.systemPrompt 和 ctx.getSystemPrompt() 都反映当前处理程序的链式系统提示。后面的 before_agent_start 处理程序仍可再次修改它。
agent_start / agent_end
每个用户提示触发一次。
pi.on("agent_start", async (_event, ctx) => {});
pi.on("agent_end", async (event, ctx) => {
// event.messages - 此提示产生的消息
});
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(逐 token 流事件)
});
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 在每个工具完成后按工具完成顺序发出
- 最终的
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_request
在构建 Provider 特定负载后、请求发送前触发。处理程序按扩展加载顺序运行。返回 undefined 保持负载不变。返回其他任何值将替换后续处理程序和实际请求的负载。
这个钩子可以重写 Provider 级别的系统指令或完全删除它们。这些负载级别的更改不会反映在 ctx.getSystemPrompt() 中,后者报告的是 Pi 的系统提示字符串,而不是最终序列化的 Provider 负载。
pi.on("before_provider_request", (event, ctx) => {
console.log(JSON.stringify(event.payload, null, 2));
// 可选:替换负载
// return { ...event.payload, temperature: 0 };
});
这主要用于调试 Provider 序列化和缓存行为。
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"]);
}
});
标头的可用性取决于 Provider 和传输层。抽象 HTTP 响应的 Provider 可能不会暴露标头。
模型事件
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_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}`);
}
});
类型化自定义工具输入
自定义工具应导出其输入类型:
// 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_execution_end 和最终 toolResult 消息事件发出之前触发。可以修改结果。
在并行工具模式下,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
在用户执行 ! 或 !! 命令时触发。可以拦截。
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 } };
});
输入事件
在收到用户输入后、扩展命令检查之后、skill 和模板扩展之前触发。事件看到的是原始输入文本,因此 /skill:foo 和 /template 尚未被扩展。
处理顺序:
- 先检查扩展命令(
/cmd)——如果找到,处理程序运行,跳过 input 事件
input 事件触发——可以拦截、转换或处理
- 如果未处理:skill 命令(
/skill:name)扩展为 skill 内容
- 如果未处理:提示模板(
/template)扩展为模板内容
- Agent 处理开始(
before_agent_start 等)
pi.on("input", async (event, ctx) => {
// event.text - 原始输入(在 skill/模板扩展之前)
// event.images - 附带的图片(如果有)
// event.source - "interactive"(键入)、"rpc"(API)或 "extension"(通过 sendUserMessage)
// 转换:在扩展前重写输入
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" };
// 在扩展前拦截 skill 命令
if (event.text.startsWith("/skill:")) {
// 可以转换、阻止或让其通过
}
return { action: "continue" }; // 默认:通过到扩展
});
结果:
continue——保持不变通过(如果处理程序不返回任何内容,则为默认)
transform——修改文本/图片,然后继续到扩展
handled——完全跳过 Agent(第一个返回此值的处理程序生效)
转换在处理程序间链式拼接。参见 input-transform.ts。
ExtensionContext
所有处理程序都接收 ctx: ExtensionContext。
ctx.ui
用于用户交互的 UI 方法。完整详情请参见 自定义 UI。
ctx.hasUI
在打印模式(-p)和 JSON 模式下为 false。在交互式和 RPC 模式下为 true。在 RPC 模式下,对话框方法(select、confirm、input、editor)通过扩展 UI 子协议工作,而即发即弃方法(notify、setStatus、setWidget、setTitle、setEditorText)向客户端发出请求。某些 TUI 特定方法是无操作或返回默认值(参见 rpc.md)。
ctx.cwd
当前工作目录。
ctx.sessionManager
对会话状态的只读访问。完整的 SessionManager API 和条目类型请参见 Session Format。
对于 tool_call,此状态在处理程序运行前已通过当前助手消息同步。在并行工具执行模式下,仍不能保证包含同一条助手消息中的兄弟工具结果。
ctx.sessionManager.getEntries() // 所有条目
ctx.sessionManager.getBranch() // 当前分支
ctx.sessionManager.getLeafId() // 当前叶子条目 ID
ctx.modelRegistry / ctx.model
访问模型和 API 密钥。
ctx.signal
当前的 Agent 中止信号,如果未激活 Agent 回合则为 undefined。
将此用于扩展处理程序启动的、支持中止感知的嵌套工作,例如:
fetch(..., { signal: ctx.signal })
- 接受
signal 的模型调用
- 接受
AbortSignal 的文件或进程辅助函数
ctx.signal 通常在活动回合事件(如 tool_call、tool_result、message_update 和 turn_end)期间定义。
在空闲或非回合上下文(如会话事件、扩展命令以及在 pi 空闲时触发的快捷键)中通常为 undefined。
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()
控制流辅助方法。
ctx.shutdown()
请求优雅关闭 pi。
- 交互模式: 延迟到 Agent 变为空闲后(处理完所有排队的引导和后续消息后)。
- RPC 模式: 延迟到下一个空闲状态(完成当前命令响应后,等待下一个命令时)。
- 打印模式: 无操作。进程在处理完所有提示后自动退出。
在退出前向所有扩展发出 session_shutdown 事件。在所有上下文中可用(事件处理程序、工具、命令、快捷键)。
pi.on("tool_call", (event, ctx) => {
if (isFatal(event.input)) {
ctx.shutdown();
}
});
ctx.getContextUsage()
返回当前活动模型的上下文使用情况。在可用时使用最后一次的助手使用数据,然后估算尾部消息的 token 数。
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.waitForIdle()
等待 Agent 完成流式输出:
pi.registerCommand("my-cmd", {
handler: async (args, ctx) => {
await ctx.waitForIdle();
// Agent 现在空闲,可以安全修改会话
},
});
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 运行前修改新会话的 SessionManager
withSession:针对新的替换会话上下文运行切换后工作。不要使用捕获的旧 pi / 命令 ctx;参见 会话替换生命周期及陷阱。
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;参见 会话替换生命周期及陷阱。
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;参见 会话替换生命周期及陷阱。
要发现可用会话,使用静态方法 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");
},
});
}
},
});
会话替换生命周期及陷阱
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("wrong");
},
});
},
});
ctx.reload()
执行与 /reload 相同的重载流程。
pi.registerCommand("reload-runtime", {
description: "重载扩展、skill、prompt 和主题",
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: "重载扩展、skill、prompt 和主题",
handler: async (_args, ctx) => {
await ctx.reload();
return;
},
});
pi.registerTool({
name: "reload_runtime",
label: "重载运行时",
description: "重载扩展、skill、prompt 和主题",
parameters: Type.Object({}),
async execute() {
pi.sendUserMessage("/reload-runtime", { deliverAs: "followUp" });
return {
content: [{ type: "text", text: "已将 /reload-runtime 排队为后续命令。" }],
};
},
});
}
ExtensionAPI 方法
pi.on(event, handler)
订阅事件。事件类型和返回值请参见 事件。
注册 LLM 可调用的自定义工具。完整详情请参见 自定义工具。
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: "我的工具",
description: "此工具的功能",
promptSnippet: "根据操作汇总或转换文本",
promptGuidelines: ["当用户要求汇总之前生成的文本时使用 my_tool。"],
parameters: Type.Object({
action: StringEnum(["list", "add"] as const),
text: Type.Optional(Type.String()),
}),
prepareArguments(args) {
// 可选兼容性 shim。在模式验证前运行。
// 返回当前模式形状,例如将遗留字段合并到现代参数对象中。
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?)
向会话注入自定义消息。
pi.sendMessage({
customType: "my-extension",
content: "消息文本",
display: true,
details: { ... },
}, {
triggerTurn: true,
deliverAs: "steer",
});
选项:
deliverAs - 传递模式:
"steer"(默认)- 在流式传输时排队。在当前助手回合完成工具调用后、下一次 LLM 调用之前传递。
"followUp" - 等待 Agent 完成。仅当 Agent 不再有工具调用时传递。
"nextTurn" - 排队用于下一次用户提示。不中断或触发任何操作。
triggerTurn: true - 如果 Agent 空闲,立即触发 LLM 响应。仅适用于 "steer" 和 "followUp" 模式("nextTurn" 忽略此选项)。
pi.sendUserMessage(content, options?)
向 Agent 发送用户消息。不同于 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 - Agent 正在流式传输时需要:
"steer" - 将消息排队,在当前助手回合完成工具调用后传递
"followUp" - 等待 Agent 完成所有工具
不在流式传输时,消息会立即发送并触发新回合。在流式传输时如果未提供 deliverAs,会抛出错误。
完整示例请参见 send-user-message.ts。
pi.appendEntry(customType, data?)
持久化扩展状态(不参与 LLM 上下文)。
pi.appendEntry("my-state", { count: 42 });
// 在重载时恢复
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 调用的斜杠命令。包括扩展命令、prompt 模板和 skill 命令。
列表顺序与 RPC get_commands 一致:扩展优先,然后是模板,最后是 skill。
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 渲染器。参见 自定义 UI。
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
管理活动工具。适用于内置工具和动态注册的工具。
const active = pi.getActiveTools();
const all = pi.getAllTools();
// [{
// name: "read",
// description: "读取文件内容...",
// parameters: ...,
// sourceInfo: { path: "<builtin:read>", source: "builtin", scope: "temporary", origin: "top-level" }
// }, ...]
const names = all.map(t => t.name);
const builtinTools = all.filter((t) => t.sourceInfo.source === "builtin");
const extensionTools = all.filter((t) => t.sourceInfo.source !== "builtin" && t.sourceInfo.source !== "sdk");
pi.setActiveTools(["read", "bash"]); // 切换到只读
pi.getAllTools() 返回 name、description、parameters 和 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"
pi.setThinkingLevel("high");
pi.events
扩展间通信的共享事件总线:
pi.events.on("my:event", (data) => { ... });
pi.events.emit("my:event", { ... });
pi.registerProvider(name, config)
动态注册或覆盖模型 Provider。适用于代理、自定义端点或团队范围的模型配置。
在扩展工厂函数中进行的调用会排队,并在运行器初始化时应用。之后进行的调用——例如来自用户设置流程后的命令处理程序——立即生效,无需 /reload。
如果需要从远程端点发现模型,建议使用异步扩展工厂,而不是将 fetch 推迟到 session_start。Pi 会在继续启动前等待工厂,因此注册的模型立即可用,包括对 pi --list-models。
// 使用自定义模型注册新 Provider
pi.registerProvider("my-proxy", {
name: "我的代理",
baseUrl: "https://proxy.example.com",
apiKey: "PROXY_API_KEY", // 环境变量名或字面值
api: "anthropic-messages",
models: [
{
id: "claude-sonnet-4-20250514",
name: "Claude 4 Sonnet(代理)",
reasoning: false,
input: ["text", "image"],
cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
contextWindow: 200000,
maxTokens: 16384
}
]
});
// 覆盖现有 Provider 的 baseUrl(保留所有模型)
pi.registerProvider("anthropic", {
baseUrl: "https://proxy.example.com"
});
// 注册支持 OAuth 的 Provider 以支持 /login
pi.registerProvider("corporate-ai", {
baseUrl: "https://ai.corp.com",
api: "openai-responses",
models: [...],
oauth: {
name: "企业 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 - Provider 在 UI 中(如 /login)的显示名称。
baseUrl - API 端点 URL。定义模型时需要。
apiKey - API 密钥或环境变量名称。定义模型时需要(除非提供了 oauth)。
api - API 类型:"anthropic-messages"、"openai-completions"、"openai-responses" 等。
headers - 要包含在请求中的自定义标头。
authHeader - 如果为 true,自动添加 Authorization: Bearer 标头。
models - 模型定义数组。如果提供,替换此 Provider 的所有现有模型。模型定义可以设置 baseUrl 以覆盖该模型的 Provider 端点。
oauth - 支持 /login 的 OAuth Provider 配置。提供后,该 Provider 会出现在登录菜单中。
streamSimple - 用于非标准 API 的自定义流式实现。
高级主题(自定义流式 API、OAuth 详情、模型定义参考)请参见 custom-provider.md。
pi.unregisterProvider(name)
移除先前注册的 Provider 及其模型。被该 Provider 覆盖的内置模型会被恢复。如果该 Provider 未注册,则无效果。
与 registerProvider 类似,在初始加载阶段之后调用时立即生效,无需 /reload。
pi.registerCommand("my-setup-teardown", {
description: "移除自定义代理 Provider",
handler: async (_args, _ctx) => {
pi.unregisterProvider("my-proxy");
},
});
状态管理
有状态的扩展应将状态存储在工具结果的 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("new item");
return {
content: [{ type: "text", text: "已添加" }],
details: { items: [...items] }, // 存储以便重建
};
},
});
}
自定义工具
通过 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: {},
};
});
}
工具定义
import { Type } from "typebox";
import { StringEnum } from "@earendil-works/pi-ai";
import { Text } from "@earendil-works/pi-tui";
pi.registerTool({
name: "my_tool",
label: "我的工具",
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 获取 Agent 在最终结构化输出工具调用后结束的最小示例。
// 正确:抛出错误以表示错误
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: "编辑",
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: {},
};
},
});
覆盖内置工具
扩展可以通过注册同名工具来覆盖内置工具(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 和会话逻辑依赖这些形状进行渲染和状态跟踪。
内置工具实现:
远程执行
内置工具支持可插拔的操作,用于委派到远程系统(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,扩展可以通过 createLocalBashOperations() 重用 pi 的本地 Shell 后端,而无需重新实现本地进程启动、Shell 解析和进程树终止。
bash 工具还支持 spawn 钩子,用于在执行前调整命令、cwd 或环境:
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 标志。
输出截断
工具必须截断其输出,以避免淹没 LLM 上下文。大型输出可能导致:
- 上下文溢出错误(提示过长)
- 压缩失败
- 模型性能下降
内置限制为 50KB(约 10k token)和 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)并带有正确的截断。
多个工具
一个扩展可以使用共享状态注册多个工具:
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();
});
}
自定义渲染
工具可以提供 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: "我的工具",
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。
快捷键提示
使用 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()。
最佳实践
- 使用带内边距
(0, 0) 的 Text。默认的 Box 处理内边距。
- 使用
\n 处理多行内容。
- 处理
isPartial 以支持流式进度。
- 支持
expanded 以按需显示详情。
- 保持默认视图紧凑。
- 在
renderResult 中读取 context.args,而不是将 args 复制到 context.state 中。
- 仅将必须跨调用和结果插槽共享的数据放入
context.state。
- 当相同组件实例可以原地更新时,重用
context.lastComponent。
- 仅在默认的盒式外壳妨碍您时使用
renderShell: "self"。在自外壳模式下,工具负责自己的框架、内边距和背景。
后备
如果插槽渲染器未定义或抛出:
renderCall:显示工具名称
renderResult:显示 content 中的原始文本
自定义 UI
扩展可以通过 ctx.ui 方法与用户交互,并自定义消息/工具的渲染方式。
有关自定义组件,请参见 tui.md,其中包含以下内容的可复制粘贴模式:
- 选择对话框(SelectList)
- 带取消的异步操作(BorderedLoader)
- 设置开关(SettingsList)
- 状态指示器(setStatus)
- 流式传输期间的工作消息、可见性和指示器(
setWorkingMessage、setWorkingVisible、setWorkingIndicator)
- 编辑器上方/下方的组件(setWidget)
- 叠加在内置斜杠/路径补全上的自动补全提供者(addAutocompleteProvider)
- 自定义底部栏(setFooter)
对话框
// 从选项中选择
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"
带倒计时的定时对话框
对话框支持 timeout 选项,会在自动关闭时显示实时倒计时:
// 对话框显示 "标题 (5s)" → "标题 (4s)" → ... → 到 0 时自动关闭
const confirmed = await ctx.ui.confirm(
"定时确认",
"此对话框将在 5 秒后自动取消。确认吗?",
{ timeout: 5000 }
);
if (confirmed) {
// 用户已确认
} else {
// 用户取消或超时
}
超时时的返回值:
select() 返回 undefined
confirm() 返回 false
input() 返回 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。
组件、状态和底部栏
// 底部栏状态(持久存在,直到清除)
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) => ({
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(...)。
自动补全提供者
使用 ctx.ui.addAutocompleteProvider() 在内置斜杠命令和路径提供者之上堆叠自定义自动补全逻辑。
典型模式:
- 检查光标前的文本
- 当您的扩展特定语法匹配时,返回您自己的建议
- 否则委托给
current.getSuggestions(...)
- 委托
applyCompletion(...),除非您需要自定义插入行为
pi.on("session_start", (_event, ctx) => {
ctx.ui.addAutocompleteProvider((current) => ({
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 Issue,并在本地过滤以实现快速的 #... 补全。需要 GitHub CLI(gh)和 GitHub 仓库签出。
自定义组件
对于复杂 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: 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.setHidden(true/false) */ }
}
);
完整的 OverlayOptions API 请参见 tui.md,示例请参见 overlay-qa-tests.ts。
自定义编辑器
用自定义实现替换主输入编辑器(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
- 在
setEditorComponent() 前使用 ctx.ui.getEditorComponent() 来包装先前配置的自定义编辑器
- 传递
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,包含模式指示器。
消息渲染
为具有您的 customType 的消息注册自定义渲染器:
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: { ... }, // 在渲染器中可用
});
主题颜色
所有渲染函数都接收一个 theme 对象。创建自定义主题和完整色彩 palette 请参见 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);
错误处理
- 扩展错误会被记录,Agent 继续运行
tool_call 错误会阻止该工具(故障安全)
- 工具
execute 错误必须通过抛出错误信号来传递;抛出的错误会被捕获,以 isError: true 报告给 LLM,执行继续
模式行为
在非交互模式下,使用 UI 方法前请检查 ctx.hasUI。
示例参考
所有示例位于 examples/extensions/。
法律声明: 本页面是 pi.dev 官方文档的中文翻译版本,仅供学习参考。本网站与 pi.dev 及 Earendil Inc. 无任何法律关系。