docs: 增加 pi agent 使用说明 #91

Merged
gjm merged 1 commits from company-desktop/company-desktop-computer/doc-pi-agent-usage AGit into main 2026-10-28 11:00:40 +08:00
Collaborator

新增 pi-agent-setup.md,把这几轮摸出来的 pi 使用知识固定下来,供三台机器
共用:

  • 仓库里放了什么:AGENTS.md、4 个 skill、3 个 prompt 模板,以及加载规则
    (AGENTS.md 作为 context file 不需要项目信任,.pi/ 下需要)。
    并说明 AGENTS.md 为何不复制 CODEBUDDY.md 正文。
  • 常用命令:启动参数(-c/-r/--session/--fork/--tui-mode/-e/--offline)、
    会话命令(/new /resume /tree /fork /clone /compact)、资源命令。
  • 重点澄清 /reload 不恢复会话:它只重载 skill/prompt/AGENTS.md/主题/扩展,
    历史靠 -c / -r / /resume;并给出 pull 之后的推荐顺序,以及"会话按工作
    目录关联"这个容易踩的点。
  • Windows 终端底部状态栏上下跳动:定位到三条叠加原因(cmd 的默认宿主是
    conhost、terminal.clearOnShrink 默认 false、窗口不够宽导致 footer 折行),
    给出按性价比排序的处理办法和 PI_TUI_WRITE_LOG 排查手段,附当前本机配置
    与桌面快捷方式的实际参数。
  • 三台机器的同步清单:哪些随仓库走、哪些必须各自准备、三个坑
    (.pi/settings.json 冲突、项目级与用户级 skill 目录、首次要授予项目信任)。
  • 插件取舍:pi-lens 对本仓库为何不建议装(clangd 需要 compile_commands.json
    而本项目用 VS 生成器、编译检查不带 ARX/MFC 宏、无 .clang-format 且强制
    UTF-8 BOM),以及少数值得考虑的包和明确不需要的包。
  • 其他已知坑:pi 不读 CODEBUDDY.md、内置工具只有 read/write/edit/bash、
    UTF-8 BOM 约定、类名与文件名不一致。

同时在 AGENTS.md 里加一行指向该文档。

新增 pi-agent-setup.md,把这几轮摸出来的 pi 使用知识固定下来,供三台机器 共用: - 仓库里放了什么:AGENTS.md、4 个 skill、3 个 prompt 模板,以及加载规则 (AGENTS.md 作为 context file 不需要项目信任,.pi/ 下需要)。 并说明 AGENTS.md 为何不复制 CODEBUDDY.md 正文。 - 常用命令:启动参数(-c/-r/--session/--fork/--tui-mode/-e/--offline)、 会话命令(/new /resume /tree /fork /clone /compact)、资源命令。 - 重点澄清 /reload 不恢复会话:它只重载 skill/prompt/AGENTS.md/主题/扩展, 历史靠 -c / -r / /resume;并给出 pull 之后的推荐顺序,以及"会话按工作 目录关联"这个容易踩的点。 - Windows 终端底部状态栏上下跳动:定位到三条叠加原因(cmd 的默认宿主是 conhost、terminal.clearOnShrink 默认 false、窗口不够宽导致 footer 折行), 给出按性价比排序的处理办法和 PI_TUI_WRITE_LOG 排查手段,附当前本机配置 与桌面快捷方式的实际参数。 - 三台机器的同步清单:哪些随仓库走、哪些必须各自准备、三个坑 (.pi/settings.json 冲突、项目级与用户级 skill 目录、首次要授予项目信任)。 - 插件取舍:pi-lens 对本仓库为何不建议装(clangd 需要 compile_commands.json 而本项目用 VS 生成器、编译检查不带 ARX/MFC 宏、无 .clang-format 且强制 UTF-8 BOM),以及少数值得考虑的包和明确不需要的包。 - 其他已知坑:pi 不读 CODEBUDDY.md、内置工具只有 read/write/edit/bash、 UTF-8 BOM 约定、类名与文件名不一致。 同时在 AGENTS.md 里加一行指向该文档。
company-desktop added 1 commit 2026-10-28 11:00:06 +08:00
新增 pi-agent-setup.md,把这几轮摸出来的 pi 使用知识固定下来,供三台机器
共用:

- 仓库里放了什么:AGENTS.md、4 个 skill、3 个 prompt 模板,以及加载规则
  (AGENTS.md 作为 context file 不需要项目信任,.pi/ 下需要)。
  并说明 AGENTS.md 为何不复制 CODEBUDDY.md 正文。
- 常用命令:启动参数(-c/-r/--session/--fork/--tui-mode/-e/--offline)、
  会话命令(/new /resume /tree /fork /clone /compact)、资源命令。
- 重点澄清 /reload 不恢复会话:它只重载 skill/prompt/AGENTS.md/主题/扩展,
  历史靠 -c / -r / /resume;并给出 pull 之后的推荐顺序,以及"会话按工作
  目录关联"这个容易踩的点。
- Windows 终端底部状态栏上下跳动:定位到三条叠加原因(cmd 的默认宿主是
  conhost、terminal.clearOnShrink 默认 false、窗口不够宽导致 footer 折行),
  给出按性价比排序的处理办法和 PI_TUI_WRITE_LOG 排查手段,附当前本机配置
  与桌面快捷方式的实际参数。
- 三台机器的同步清单:哪些随仓库走、哪些必须各自准备、三个坑
  (.pi/settings.json 冲突、项目级与用户级 skill 目录、首次要授予项目信任)。
- 插件取舍:pi-lens 对本仓库为何不建议装(clangd 需要 compile_commands.json
  而本项目用 VS 生成器、编译检查不带 ARX/MFC 宏、无 .clang-format 且强制
  UTF-8 BOM),以及少数值得考虑的包和明确不需要的包。
- 其他已知坑:pi 不读 CODEBUDDY.md、内置工具只有 read/write/edit/bash、
  UTF-8 BOM 约定、类名与文件名不一致。

同时在 AGENTS.md 里加一行指向该文档。
gjm approved these changes 2026-10-28 11:00:30 +08:00
gjm merged commit cb5967128d into main 2026-10-28 11:00:40 +08:00
Sign in to join this conversation.
No Reviewers
No labels
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: gjm/envi-code#91