第四部分,Extensions 开发

自定义命令、Flags 与快捷键

通过 registerCommand、registerFlag 和 registerShortcut 构建可发现的终端工作流。

命令与 Flags

registerCommand 添加 Slash Command,适合明确的用户动作。registerFlag 添加 CLI 选项,扩展可以在启动时读取。

命令名称应稳定,参数需要帮助文本和验证。改变 Session 或外部系统的命令要说明副作用。

typescript
pi.registerCommand("health", {
  description: "Check project health",
  handler: async (_args, ctx) => {
    ctx.ui.notify("Project is ready", "info");
  },
});

快捷键设计

registerShortcut 适合高频动作,但要避免覆盖核心编辑键和终端保留键。通过 keybindings manager 展示当前实际绑定。

为所有快捷动作提供等价命令,保证远程和无障碍环境仍可使用。

官方资料

本页由 xueai 根据 Pi 官方资料用中文重新组织和讲解。Pi 更新频繁,命令、包名和接口以官方最新文档为准。

Pi 源代码和官方文档采用 MIT License。Copyright (c) 2025 Mario Zechner。本站保留原版权与许可声明,完整文本见 MIT License