プロンプトテンプレート · Pi 日本語ドキュメント

プロンプトテンプレートは、Markdown ファイルを再利用可能な / コマンドに変換します。実行可能な動作や、より大規模な補助命令一式を追加せずに同じプロンプトを再利用したい場合に使用します。

テンプレートは引数を受け取ることができ、コマンド補完に表示できます。Pi は、個人設定、プロジェクト設定、明示的なパス、または Pi パッケージからテンプレートを読み込めます。プロジェクト設定は、プロジェクトが信頼された後にのみ読み込まれます。

テンプレートを作成する#

~/.pi/agent/prompts/review.md を作成します。

markdown

---
description: Review staged git changes
argument-hint: "[focus]"
---
Review the staged changes. Focus on ${1:-correctness, security, and error handling}.

ファイル名がコマンド名になるため、このテンプレートは /review として使用できます。description はコマンド補完に表示されます。省略した場合、Pi は最初の空でない行を使用します。

argument-hint は省略可能です。必須の引数には <angle brackets> を、省略可能な引数には [square brackets] を使用します。

アクティブなセッションでテンプレートを追加または変更した後は、/reload を実行します。

テンプレートを使用する#

エディターでテンプレートコマンドを入力します。

text

/review
/review concurrency

Pi は、生成されたテキストがエージェントに渡される前にテンプレートを展開します。同じ名前の拡張機能コマンドが処理する場合を除き、拡張機能は最初に input イベントを通じて未加工の入力を受け取ります。

テンプレートは次の置換をサポートします。

構文	結果
`$1`、`$2`、…	1 つの位置引数
`$@` または `$ARGUMENTS`	すべての引数をスペースで連結したもの
`${1:-default}`	最初の引数、またはデフォルト値
`${@:-default}`	すべての引数、またはデフォルト値
`${@:N}`	位置 `N` から始まる引数
`${@:N:L}`	位置 `N` から始まる `L` 個の引数

引数はシェル形式の引用規則に従うため、/review "API compatibility" はスペースを含む 1 つの引数を渡します。

Pi に追加する#

テンプレートをユーザーまたはプロジェクトのプロンプトディレクトリに配置します。規定のプロンプトディレクトリでは、直下の .md ファイルのみが読み込まれます。

設定とパッケージでは、ネストされた Markdown ファイルを選択できます。パッケージマニフェストでは、明示的なパスと glob を使用して検出対象を絞り込めます。これらのオプションについては、設定および Pi パッケージを参照してください。

プロジェクトのテンプレートは、信頼が付与されるとエディター内でコマンドとして使用できるようになります。不慣れなプロジェクトを信頼する前に、その内容を確認してください。セキュリティを参照してください。