Pi 可创建提示模板 为你的工作流定制一个

badlogic 发布于 2026-07-18 阅读 13

本文介绍了 Pi 工具中的提示模板功能。用户可以通过在编辑器中输入 / 加模板名来快速插入预定义的 Markdown 提示片段。模板可以从全局、项目、包、设置或 CLI 中加载。模板支持 YAML 前置元数据(如描述和参数提示),以及位置参数、默认值和切片操作。文章还说明了模板的加载规则。

提示模板

提示模板是 Markdown 片段,可展开为完整提示。在编辑器中输入 /名称 即可调用模板,其中 名称 是不带 .md 扩展名的文件名。

位置

Pi 从以下位置加载提示模板:

  • 全局:~/.pi/agent/prompts/*.md
  • 项目:.pi/prompts/*.md(仅当项目被信任后才生效)
  • 包:prompts/ 目录或 package.json 中的 pi.prompts 条目
  • 设置:包含文件或目录的 prompts 数组
  • 命令行:--prompt-template <路径>(可重复)

使用 --no-prompt-templates 禁用自动发现。

格式

---
description: 审查已暂存的 git 更改
---
审查已暂存的更改(`git diff --cached`)。重点检查:
- 错误和逻辑问题
- 安全问题
- 错误处理的缺口
  • 文件名即命令名称。review.md 对应 /review
  • description 可选。如果缺失,则使用第一个非空行。
  • argument-hint 可选。设置后,在自动补全下拉列表中,提示会显示在描述之前。

参数提示

在前置元数据中使用 argument-hint 来在自动补全中显示预期的参数。使用 \<尖括号\> 表示必需参数,\[方括号\] 表示可选参数:

---
description: 从 URL 审查 PR,进行结构化问题和代码分析
argument-hint: "<PR-URL>"
---

这会在自动补全下拉列表中显示为:

→ pr   <PR-URL>       — 从 URL 审查 PR,进行结构化问题和代码分析
  is   <issue>        — 分析 GitHub issue(错误或功能请求)
  wr   [instructions] — 端到端完成当前任务
  cl   — 审计发布前的变更日志条目

用法

在编辑器中输入 / 后跟模板名称。自动补全会显示可用模板及其描述。

/review                           # 展开 review.md
/component Button                 # 带参数展开
/component Button "click handler" # 多个参数

参数

模板支持位置参数、默认值和简单的切片操作:

  • $1$2、... 位置参数
  • $@$ARGUMENTS 表示所有参数连接在一起
  • ${1:-default}:当参数1存在且非空时使用它,否则使用 default
  • ${@:-default}${ARGUMENTS:-default}:当所有参数存在且非空时使用它们,否则使用 default
  • ${@:N}:从第N个位置(从1开始索引)开始的参数
  • ${@:N:L}:从第N个位置开始的 L 个参数

示例:

---
description: 创建一个组件
---
创建一个名为 $1 的 React 组件,具有以下特性:$@

默认值对于可选参数很有用:

用 ${1:-7} 个要点总结当前状态。

用法:/component Button "onClick handler" "disabled support"

加载规则

  • prompts/ 中的模板发现是非递归的。
  • 如果想要子目录中的模板,请通过 prompts 设置或包清单显式添加它们。
  • 原文链接: github.com/badlogic/pi-m...
  • 登链社区 AI 助手,为大家转译优秀英文文章,如有翻译不通的地方,还请包涵~

相关文章

0 条评论