HoRain云--Pi Agent 扩展入门

HoRain云小助手个人主页 个人专栏: 《Linux 系列教程》《c语言教程》⛺️生活的理想就是为了理想的生活!⛳️ 推荐前些天发现了一个超棒的服务器购买网站性价比超高大内存超划算忍不住分享一下给大家。点击跳转到网站。专栏介绍专栏名称专栏介绍《C语言》本专栏主要撰写C干货内容和编程技巧让大家从底层了解C把更多的知识由抽象到简单通俗易懂。《网络协议》本专栏主要是注重从底层来给大家一步步剖析网络协议的奥秘一起解密网络协议在运行中协议的基本运行机制《docker容器精解篇》全面深入解析 docker 容器从基础到进阶涵盖原理、操作、实践案例助您精通 docker。《linux系列》本专栏主要撰写Linux干货内容从基础到进阶知识由抽象到简单通俗易懂帮你从新手小白到扫地僧。《python 系列》本专栏着重撰写Python相关的干货内容与编程技巧助力大家从底层去认识Python将更多复杂的知识由抽象转化为简单易懂的内容。《试题库》本专栏主要是发布一些考试和练习题库涵盖软考、HCIE、HRCE、CCNA等目录⛳️ 推荐专栏介绍什么是 Extension第一个 ExtensionHello World实例扩展的加载位置实例Extension 文件结构单文件扩展目录扩展含 index.ts带依赖的扩展扩展的加载机制可用 Import 包开发提示Extensions扩展是 Pi Agent 最强大的定制方式——你可以用 TypeScript 编写自定义工具、命令和事件监听器。什么是 ExtensionExtension 是一个 TypeScript 模块它可以注册自定义工具——AI 可以调用的新功能注册自定义命令——用户通过 /命令名 调用监听生命周期事件——在 AI 工作的各个阶段插入逻辑注册键盘快捷键展示自定义 UI——在终端中渲染交互界面第一个 ExtensionHello World实例// 文件路径~/.pi/agent/extensions/my-extension.tsimport 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) {return {content: [{ type: text, text: 你好${params.name} }],details: {},};},});// 注册一个自定义命令pi.registerCommand(hello, {description: 向世界问好,handler: async (args, ctx) {ctx.ui.notify(你好 ${args || 世界}, info);},});}测试你的扩展$ pi -e ~/.pi/agent/extensions/my-extension.ts扩展的加载位置位置作用范围说明~/.pi/agent/extensions/*.ts全局对所有项目生效自动发现~/.pi/agent/extensions/*/index.ts全局子目录中有 index.ts 的扩展.pi/extensions/*.ts项目仅当前项目需项目信任.pi/extensions/*/index.ts项目项目子目录扩展也可以通过 settings.json 或 CLI 参数加载扩展# 从路径加载临时 $ pi -e ./my-extension.ts # 在 settings.json 中配置实例{extensions: [/path/to/local/extension.ts,/path/to/local/extension/dir]}Extension 文件结构单文件扩展最简单的形式适合小型扩展~/.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 # 声明依赖和入口 ├── node_modules/ # npm install 后生成 └── src/ └── index.ts扩展以你的系统权限运行可以执行任意代码。只安装来自可信来源的扩展。扩展的加载机制扩展通过 jiti 加载TypeScript 代码无需编译即可直接运行。如果你的工厂函数返回 PromisePi Agent 会在继续启动流程之前等待它完成——这意味着你可以在扩展初始化时做异步操作比如获取远程配置。可用 Import 包包名用途earendil-works/pi-coding-agent扩展类型ExtensionAPI、ExtensionContext 和各种事件类型typebox工具参数的 Schema 定义earendil-works/pi-aiAI 工具如 StringEnum用于 Google 兼容的枚举earendil-works/pi-tuiTUI 组件用于自定义渲染这些是 Pi Agent 的内置依赖应该列为 peerDependencies 而不是打包到你的扩展中。其他 npm 包也可以使用——在扩展目录中添加 package.json 并运行 npm install 即可。开发提示将扩展放在 ~/.pi/agent/extensions/ 目录中支持 /reload 热重载使用 pi -e ./path.ts 仅在快速测试时使用不要在扩展工厂函数中启动后台资源进程、socket、文件监听器、定时器等这些应该在 session_start 事件中启动在 session_shutdown 事件中清理会话级资源❤️❤️❤️本人水平有限如有纰漏欢迎各位大佬评论批评指正如果觉得这篇文对你有帮助的话也请给个点赞、收藏下吧非常感谢! Stay Hungry Stay Foolish 道阻且长,行则将至,让我们一起加油吧