admin/my-pi
1
0
Fork 0
mirror of https://bitbucket.org/siakitem/my-pi.git synced 2026-08-28 08:35:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
779a845e1849a676f838365cc63827018684e757
my-pi/AGENTS.md
T

23 KiB
Raw Blame History

仓库说明

本仓库用于维护可通过一次 pi install 部署的个人 Pi 扩展组合包。根 package.json 是唯一的组合包安装入口；根 install.sh、update.sh 和 uninstall.sh 只是对 pi install / pi update / pi remove 的便捷包装，不形成第二套部署机制。依赖、默认行为和必要配置必须由组合包自身声明或部署，不把安装后的手工配置作为默认流程。每个自维护扩展使用独立的顶层目录，扩展源码、测试和说明应保留在各自目录内。

当前扩展

  • pi-rtk-optimizer/：默认只负责非搜索工具输出压缩；RTK 命令改写为可选能力。
  • 上游来源：https://github.com/MasuRii/pi-rtk-optimizer
  • 初始导入快照：d155d253cb2f1358e34e717d47a82ebccb08cb8e（2026-07-03，0.9.0）。
  • 该目录已纳入本仓库直接维护，不是 submodule，也不保留嵌套 .git。
  • pi-permission-auto-review/：作为 pi-permission-system 的 auto-review authorizer，使用 Codex Guardian 风格策略复核权限基线产生的 ask。
  • 上游来源：https://github.com/mzwing/pi-packages/tree/main/packages/pi-permission-auto-review
  • 初始导入快照：8d196e4ef0884cac8326c366191dad3f585d470a（@mzwing/pi-permission-auto-review@0.2.0）。
  • 该目录从上游源码仓库导入并由本仓库直接维护，不使用 npm 预编译产物，不是 submodule，也不保留嵌套 .git。
  • pi-permission-system/：提供工具、路径、MCP、Skill、子代理转发与 authorizer chain 的确定性权限基线。
  • 上游来源：https://github.com/gotgenes/pi-packages/tree/main/packages/pi-permission-system
  • 初始导入快照：ec4fdb11343dc94f7185b113e559a4cf9f8dc035（pi-permission-system-v26.2.1）。
  • 该目录从明确 tag 的上游源码导入并由本仓库直接维护，不使用 npm 预编译产物，不是 submodule，也不保留嵌套 .git。
  • extensions/fff-override.ts：强制使用 FFF 官方 override 模式，统一接管 find、grep、multi_grep 和 FFF 的 @ 补全；显式 CLI flag 仍遵循 FFF 官方优先级。
  • extensions/tavily-override.ts：加载 @tavily/pi-extension，把上游工具重命名为 tavily_web_search / tavily_web_fetch，并同步改写 label 与工具提示中的内部名称。
  • @keenable/pi-search：加载 keenable_search / keenable_fetch 及其 skill，默认 keyless，KEENABLE_API_KEY 仅用于提高速率限制。
  • search_config.sh 与 extensions/search-config.ts：以交互式或参数方式把三家搜索 key 写入用户级 search.env（权限 600），并在搜索扩展初始化前加载；显式进程环境变量优先。
  • extensions/mcp.ts：通过单个共享 pi-mcp-adapter 实例同时连接 Exa 托管 MCP 与机器现有的 codegraph serve --mcp，避免重复注册 Pi 的全局 MCP flag 与命令；Exa key 只通过 x-api-key 请求头发送，原始工具映射为统一的来源前缀形式，CodeGraph 只暴露 codegraph_explore。
  • context-mode：加载上游 Pi adapter 与 skills，提供 ctx_* 工具、隔离式大输出处理和会话连续性。
  • extensions/hashline.ts：部署组合包权威 config/pi-hashline-edit.json 后加载 pi-hashline-edit，以行哈希锚点覆盖内置 read / edit；Hashline 自带 grep 强制关闭。
  • extensions/permission-system.ts：直接加载仓库内 pi-permission-system/src/index.ts，并在权限扩展注册前将 config/pi-permission-system.json 同步为全局权威配置。
  • extensions/lsp.ts：把组合包内 TypeScript Language Server CLI 物化为绝对命令路径，部署 TypeScript/Kotlin/JDT LS 全局配置并加载 pi-lsp。
  • extensions/tool-routing.ts：保留 Pi 默认系统提示词，在每轮开始前按激活工具追加简短路由规则，并提供 /dump-system-prompt 将扩展所见的有效提示词写入 .pi-debug/effective-system-prompt.md。
  • pi-lsp@0.1.7：提供声明式 LSP 接入；组合包内置 typescript-language-server@5.3.0 + typescript@6.0.3，并配置机器级 kotlin-lsp --stdio 与 jdtls。
  • pi-hermes-memory@0.9.6：提供持久记忆、会话搜索、后台学习和 secret scanning，默认使用 policy-only 模式。
  • @ogulcancelik/pi-codex-compaction@0.1.3：为 openai-codex 提供原生远程 compaction，默认阈值为 90%。
  • @ogulcancelik/pi-minimal-footer@0.1.10：用紧凑的上下文仪表和订阅用量条替换默认 footer。
  • pi-condense@2.9.1：总结已完成的工具调用批次，以短 stub 替换历史原始输出，并通过 context_tree_query 按需恢复；组合包在用户尚未配置 contextPrune.enabled 时默认开启。
  • 根包还固定安装 @tavily/pi-extension@0.1.2、@keenable/pi-search@0.1.2、pi-hashline-edit@0.8.3、typescript-language-server@5.3.0、typescript@6.0.3、pi-context-view 和 @firstpick/pi-extension-codex-fast-mode；@gotgenes/pi-permission-system 改为指向仓库内 pi-permission-system/ 的本地 file: 依赖。
  • install.sh：先安装根组合包，再交互检查 Kitty/Solarized Dark、Oh My Zsh/Powerlevel10k/Zsh 插件、CodeGraph、Kotlin LSP、Java 21+ 和 JDT LS；缺失项目只在用户明确选择 Y 后安装或配置。Powerlevel10k 默认配置来自仓库内置的 config/p10k.zsh（当前 Rainbow/ASCII 单行紧凑主题）。
  • update.sh：先通过 pi update 升级根组合包，再只升级当前已安装的终端环境和机器级依赖；未安装项直接跳过。升级前先查询并比较本地与远端版本，只有版本不同时才下载或替换；Powerlevel10k 配置优先从 pi update 后的已安装组合包读取，并与 .zshrc 受管块一起按内容比较后增量同步。
  • uninstall.sh：只移除根组合包，不卸载或还原可能被其他项目共享的终端环境、CodeGraph、Kotlin LSP、JDT LS 或 Java。

当前职责与默认行为

  • FFF 独占字面搜索。RTK 不得处理 grep、find、multi_grep 的调用或结果，也不得通过默认命令改写接管 rg、grep、find、fd。
  • RTK 默认只压缩非搜索输出，包括 Bash ANSI 清理、测试聚合、构建过滤、Git 压缩和 Lint 聚合，并记录压缩统计。
  • commandRewritingEnabled 默认 false。默认安装不依赖系统 rtk CLI；只有用户主动开启命令改写时才需要 rtk rewrite。
  • readCompaction.enabled、sourceCodeFilteringEnabled 和 smartTruncate.enabled 当前均默认 false，源码读取保持原样。未经用户明确决定，不因节省上下文而改变这些默认值。
  • 若以后开启 read 压缩，优先考虑 readCompaction + smartTruncate，源码过滤仍独立评估；必须保留精确 offset/limit 读取、短文件和行锚点的完整性。
  • Context Mode 负责避免批量读取、命令研究和网页原始内容直接撑大上下文；FFF 仍负责精确字面搜索，RTK 仍处理未走 Context Mode 的普通输出。
  • Hashline 默认以 2 字符行哈希覆盖内置 read / edit，grep 和 replaceText 均关闭；它保证锚定编辑而不负责压缩，大文件上下文节省必须来自先定位/隔离分析、再做最小范围 offset/limit 读取。
  • 工具路由规则不得替换 Pi 默认系统提示词：代码结构、调用关系和待修改 symbol 优先 CodeGraph，定义/引用/类型/诊断优先 LSP；工作区内大文件探索、分析和总结优先 ctx_execute_file，日志、构建与不可预测命令输出优先 Context Mode；字面搜索先用 FFF find 收敛文件位置，再在收敛路径内用 grep/multi_grep 获取行号；真正修改前才用小范围 Hashline read 获取新鲜锚点并用锚定 edit。在线搜索按场景只先选一个服务：广泛发现、新闻和候选来源用 Tavily，官方/技术/论文和高确定性来源用 Exa，中文、站点限定和日期筛选用 Keenable；只有必要时才跨服务复核。遇到大量结果、截断或上限时继续缩小范围，不得靠提高 limit 或倾倒全部结果解决。
  • .pi-debug/ 是 /dump-system-prompt 生成的本地诊断目录，不提交到仓库，也不作为组合包运行时配置源。
  • CodeGraph 扩展只配置 Pi 到外部 codegraph 命令的 MCP 连接。根包安装本身不安装 CodeGraph；便捷脚本仅在组合包安装完成且用户明确选择 Y 后调用官方安装器。仓库不执行 codegraph init，不创建或管理 .codegraph/，也不改动索引、更新或遥测设置。
  • CodeGraph MCP 使用 keep-alive 并只直接暴露 codegraph_explore；命令缺失、项目未初始化或连接失败时不得阻止其他扩展加载。
  • 所有 MCP 服务必须合并到 extensions/mcp.ts 创建的唯一 pi-mcp-adapter 实例；不得新增独立 adapter 扩展入口，否则会重复注册 --mcp-config、/mcp 等全局接口。根测试必须扫描全部本地扩展入口并强制这一不变量。
  • Exa MCP 使用托管 Streamable HTTP 端点和 eager lifecycle；EXA_API_KEY 通过 x-api-key 请求头发送，不得放入 URL、仓库文件或日志。所有在线搜索工具统一采用“来源名 + 原始语义工具名”的命名形式，例如 tavily_web_search、exa_web_search、keenable_search。Exa 高级搜索必须显式约束结果数量和文本长度；Tavily 输出默认控制 max_results 且非必要不请求 raw content；Keenable 优先利用中文、站点和日期筛选能力。
  • 搜索 key 默认保存在 ${XDG_CONFIG_HOME:-$HOME/.config}/my-pi/search.env，文件必须为 600 且不得提交；search_config.sh 只输出配置状态，禁止回显 key。
  • pi-context-view 只观察上下文占用，不参与压缩策略。
  • pi-condense 负责压缩已经进入会话的历史工具结果，与 Context Mode 的输入隔离职责互补；extensions/condense.ts 只在 settings.json 尚无 contextPrune.enabled 时写入 true，必须保留用户显式设置的 false，配置无效时不得覆盖原文件。其他参数沿用上游默认，包括 agent-message 触发模式和 skill 路径保护。
  • Codex fast mode 只为符合条件的 openai-codex-responses 请求设置 priority service tier，由 /fast-mode 在会话内控制。
  • 权限策略默认允许常规工具，允许 FFF 工具；拒绝 Bash 直搜和敏感凭据路径；Git 非只读操作、包管理、外部目录、文件/系统/网络高风险操作与普通 MCP 调用先由 pi-permission-system 判为 ask。
  • pi-permission-auto-review 不是独立 tool_call gate，而是 pi-permission-system authorizer chain 中名为 auto-review 的链路；只复核权限基线产生的 ask，不会重复处理已 allow 或已 deny 的请求。
  • reviewer 返回 allow 时自动批准、返回 deny 时直接拒绝，配置、模型、认证、超时或响应异常时必须 defer 到正常人工提示。pi-permission-system 的 delegation envelope 继续禁止 authorizer 自动批准全部 path 请求；external_directory 只对内置 read 接受 reviewer 的 allow，写入、编辑、Bash、未知工具和其他外部访问仍转人工。
  • 默认 reviewer 为 openai-codex/codex-auto-review、low reasoning、90 秒总重试预算和内置 Codex Guardian 风格策略；只把 active branch 中的直接用户消息与已识别结构化问答作为授权证据，assistant/tool/compaction 内容不能自行授权。
  • config/pi-permission-system.json 必须显式配置 authorizerChain: ["auto-review"]，并把需要自动复核的 Git 非只读操作、包管理及其他类别声明为 ask；硬 deny 不得改成可由模型覆盖的 ask。
  • pi-lsp 的 TypeScript/JavaScript 后端由根包固定依赖提供，extensions/lsp.ts 使用当前 Node 可执行文件直接启动包内 typescript-language-server CLI，不得依赖或调用 VS Code GUI；Kotlin/JDT LS 仍使用组合包部署的 kotlin-lsp --stdio 与 jdtls 配置，根包不安装这两个系统可执行文件，便捷脚本可在用户逐项明确确认后通过 Homebrew 安装 Kotlin LSP、Java 21 和 JDT LS。
  • 终端环境配置只属于便捷脚本：Kitty 可选安装后可通过官方 kitten 启用 Solarized Dark；Oh My Zsh 使用不切换 shell 的 unattended 安装；Powerlevel10k 将仓库内置的 config/p10k.zsh（Rainbow/ASCII 单行紧凑主题）部署到 ~/.config/my-pi/p10k.zsh（遵循 XDG_CONFIG_HOME），不得覆盖用户自己的 ~/.p10k.zsh。.zshrc 中脚本拥有的内容必须使用 # >>> my-pi:<id> >>> / # <<< my-pi:<id> <<< 受管块，更新时只替换块内内容；标记不完整或重复时拒绝修改。实际修改前必须创建带时间戳的备份。git、zsh-autosuggestions、zsh-syntax-highlighting 在安装流程中逐项询问后才安装或启用。
  • Codex 远程压缩只对 openai-codex 生效，默认在 turn boundary 达到 90% 时触发；Hermes Memory 默认使用 policy-only 模式。
  • install.sh 默认从 git:git@bitbucket.org:siakitem/my-pi.git 安装，并允许用 PI_PACKAGE_SOURCE 覆盖来源；组合包安装失败时立即停止，机器级依赖安装失败时继续检查其余依赖并最终返回非零状态。
  • CodeGraph 的可选安装使用官方远程安装脚本；macOS Kitty 使用 Homebrew cask，其他系统使用 Kitty 官方安装器；Kotlin LSP、Java 21 和 JDT LS 使用 Homebrew；Oh My Zsh 使用官方安装器，Powerlevel10k 与两个第三方 Zsh 插件从各自官方 Git 仓库克隆。升级时 Git checkout、Homebrew 包、Kitty 官方安装和 CodeGraph 都必须先比较本地与远端版本，版本一致时不得重新下载安装；无法可靠比较时保留现状并报告。缺少 Homebrew、curl 或 git 时保留已经完成的组合包安装并报告失败。
  • install.sh 不检查默认不需要的 rtk CLI；update.sh 和 uninstall.sh 使用同一个 PI_PACKAGE_SOURCE 规则分别调用 pi update 和 pi remove。运行 update.sh 视为明确授权升级已安装组件及同步已有受管配置，但不得安装缺失组件或改写受管块之外的用户配置；卸载仍不改动共享机器级工具。

修改边界

  • 优先在目标扩展目录内完成改动；不要让一个扩展依赖另一个扩展的未公开内部实现。
  • 保留原项目的 LICENSE、版权信息和必要的来源说明。
  • 扩展运行目录中的 config.json、日志、构建产物、覆盖率目录和依赖目录属于本地状态，不应提交；config/pi-permission-system.json、config/pi-hashline-edit.json 与 config/lsp.json 分别是权限链、Hashline 默认行为和 LSP 后端的组合包权威源配置，必须提交并维护。
  • 外部 Pi 扩展依赖必须在根 package.json 中使用精确版本，并更新根 package-lock.json；不要用仓库级 .pi/settings.json 代替组合包依赖。
  • 需要原生构建的依赖只按锁定版本加入根 allowScripts；当前仅允许 Hermes Memory 所需的 better-sqlite3，不得批量批准其他 install scripts。
  • Pi 核心包只作为宿主 peer dependencies，不得在组合包内再安装或打包一套 Pi runtime；保留根 .npmrc 的 peer 安装策略。
  • 上游仅作为参考来源。同步上游改动时先核对本仓库已有修改，再按明确范围移植；不要直接覆盖本地实现。
  • install.sh、update.sh、uninstall.sh 和 search_config.sh 必须保持 POSIX sh 兼容和可执行权限，并包含在根 package.json 的 files 中；修改脚本行为时同步更新 README 和本文件。
  • 安装流程中的机器级依赖和用户终端配置必须保持逐项询问且默认拒绝，不得在没有用户明确确认的情况下自动安装或改写。用户主动运行 update.sh 只授权升级已安装项和同步已有受管配置；缺失项仍必须跳过。.zshrc 修改必须局限于受管块并保留备份，卸载不得顺带删除或还原共享工具和用户终端配置。
  • 未经明确要求，不执行发布、提交、推送、运行安装/卸载脚本或安装到用户 Pi 运行目录等外部写操作。

根目录 TypeScript 与 LSP 验证约定

  • 根目录当前有意不安装 Pi runtime，也没有根级 tsconfig.json、devDependencies 或 @types/node；@earendil-works/pi-* 只作为 optional host peer dependencies。TypeScript LSP 因而会把根目录 .ts 文件放入 inferred project，不能把宿主 Pi 的运行时解析能力等同于仓库内静态类型环境。
  • 每个任务首次对相关根目录 TypeScript 文件调用 lsp_diagnostics 时先建立并记录基线；后续只关注相对基线新增、消失或位置变化的诊断。文件和类型环境都未变化时不得重复调用 LSP 并重复报告同一组结果。
  • 当前可预期的基线包括：宿主 peer 缺失导致的 TS2307（例如找不到 @earendil-works/pi-coding-agent），Node 类型缺失导致的 node:* / node:test / node:assert TS2591，以及由这些上游类型缺失级联产生的 TS7006、TS18048、TS2722 等。遇到级联错误时先确认其是否随缺失类型而产生，不要把它们直接归因于本次实现。
  • 已知基线不等于忽略所有诊断：凡是无法由上述缺失依赖解释的新语法错误、结构类型错误、错误属性访问或本次修改所在代码的新诊断，必须修复并重新验证。交付时应把“已知类型环境基线”和“本次新增诊断”分开说明。
  • 不得为了消除 LSP 基线而在根包安装第二套 Pi runtime、加入机器相关的宿主绝对路径或提交只在单机有效的 paths 映射。若确需新增根级 tsconfig.json、@types/node 或其他开发类型环境，必须作为明确的仓库设计变更评估，并同步更新依赖、锁文件和本文档。
  • 不要从泛型或重载的 ExtensionAPI 方法直接用 Parameters<...> 猜取具体工具定义；解析失败时它可能退化为 unknown。包装第三方工具时优先使用上游导出的具体类型；没有稳定导出时定义覆盖实际访问字段的最小结构类型，并用运行时集成测试验证。
  • node --test 可直接测试仓库内的纯 TypeScript helper，但测试入口不得静态导入 node_modules 中的 .ts；Node 原生 type stripping 会对这种路径报 ERR_UNSUPPORTED_NODE_MODULES_TYPE_STRIPPING。第三方 TypeScript 扩展 wrapper 应拆出本地纯 helper 做单元测试，并通过隔离的临时 Pi agent/jiti 加载验证真实扩展入口。
  • 对根目录扩展的最终验证优先组合使用：纯 helper 的 node --test、git diff --check、所需 npm 锁文件检查，以及隔离 Pi 环境的扩展加载。LSP 启动成功、单元测试通过和真实 Pi 加载通过是不同证据，不得互相替代或把类型环境基线误报为 LSP 后端启动失败。

pi-rtk-optimizer 开发约定

  • 组合包运行环境为 Node.js 22.19 或更高版本；RTK 子目录开发验证还需要 npm、Bun 和项目声明的开发依赖。
  • 扩展入口是 pi-rtk-optimizer/index.ts，主要实现位于 pi-rtk-optimizer/src/。
  • RTK 命令改写默认关闭；若用户主动开启，其命令支持策略由已安装的 rtk rewrite 决定，不在扩展内重复维护规则。
  • FFF override 独占搜索工具与搜索输出；RTK 不得处理 grep 工具结果。
  • read 压缩属于有损能力。任何默认值调整都必须同时说明哪些内容可能被省略、精确读取如何恢复原文，以及对 edit 文本匹配和排障证据的影响。
  • 修改配置结构时同步检查默认值、归一化逻辑、设置界面、类型定义、README 示例和相关测试。
  • 工具输出压缩可能损失证据。排障和审计相关改动应优先保证原始输出可恢复，并覆盖锚点完整性和截断边界。

pi-permission-system 开发约定

  • 扩展入口是 pi-permission-system/src/index.ts，公共跨扩展服务入口是 pi-permission-system/src/service.ts，测试保留在该目录的 test/。
  • 同步上游必须从明确 tag/commit 移植并记录快照；保留上游 LICENSE、作者和来源，不导入 dist/、嵌套 .git 或上游包目录的 .pi 本地状态。
  • 本地 delegation envelope 只允许内置 read 对 external_directory 接受 authorizer 的 allow；write、edit、Bash、未知工具、未确定 surface 以及全部 path ask 必须继续 defer 到终端人工 authority。
  • 修改 gate、authorizer chain、delegation envelope、子代理转发或公共 service 类型时，必须同步更新包内 README/架构文档和对应测试。
  • 根包必须通过 file:./pi-permission-system 提供运行时依赖，包装入口必须直接加载仓库源码；不得同时加载 npm 预编译入口或第二个 permission-system 实例。

pi-permission-auto-review 开发约定

  • 扩展入口是 pi-permission-auto-review/index.ts，主要实现位于 pi-permission-auto-review/src/，测试保留在该目录的 test/。
  • 同步上游时必须从源码仓库的明确 tag/commit 移植并记录快照；不得以 npm tarball、dist/ 或 node_modules 中的编译产物覆盖本地源码。
  • 保留上游 LICENSE、作者和来源信息；本地兼容改动优先保持在目标目录内，不依赖其他扩展的未公开内部实现。
  • reviewer 只能处理 pi-permission-system 已判定为 ask 的请求；不得绕过硬 deny，不得另加并行 tool_call 审批层，也不得扩大 pi-permission-system 明确授予的 delegation envelope。
  • 修改 reviewer 策略、可信证据边界、配置结构、模型解析或 authorizer 注册时，必须同步更新 README、schema 和相应测试。

验证

组合包依赖或加载入口变化时，至少验证根 npm install 幂等、锁文件有效、MCP adapter 唯一所有者不变量测试，以及全部扩展可在隔离的临时 Pi agent 目录加载。权限配置变化时使用仓库内固定快照的 pi-permission-system schema 校验，并验证包装入口部署后的文件与仓库源配置一致。

安装、升级、卸载或搜索配置脚本变化时，至少运行 sh -n install.sh、sh -n update.sh、sh -n uninstall.sh、sh -n search_config.sh 和 ShellCheck，并核对脚本仍具有可执行权限、仍包含在根 package.json 的 files 中、README 描述与实际流程一致。搜索配置测试只能使用虚拟 key 和隔离 HOME，不得把真实 key 写入测试输出。涉及真实 pi install、pi update、pi remove、Homebrew、远程安装器、Git 克隆或真实用户终端配置的端到端验证属于外部写操作，未经明确要求不得执行；可以使用隔离的临时 HOME 和 mock 命令验证分支行为。

在 pi-permission-system/ 内至少运行 npm run typecheck、npm run test 和 npm run build。在 pi-permission-auto-review/ 内至少运行同样三项；涉及权限集成时还要使用仓库内 pi-permission-system 验证 authorizer 注册、allow / deny / defer 与 delegation envelope。

在 pi-rtk-optimizer/ 内按改动范围选择最小充分验证：

  • npm run build：TypeScript 转译检查。
  • npm run typecheck：完整类型检查。
  • npm run test：运行 Bun 测试。
  • npm run check：类型、测试和打包检查的完整验证。

若环境缺少依赖或未执行某项验证，交付时明确说明，不以静态检查代替运行结果。

Reference in New Issue View Git Blame Copy Permalink