Modèle de prompt Pi Agent

Les modèles de prompt sont des extraits Markdown prédéfinis qui peuvent être développés en prompts complets avec une commande courte, ce qui améliore l'efficacité pour les tâches répétitives.


Aperçu des modèles

Le fonctionnement des modèles de prompt est simple :

  1. Créez un fichier Markdown pour définir le contenu du modèle
  2. Tapez dans l'éditeur/template-namepour l'invoquer
  3. Le modèle se développe et s'insère automatiquement dans l'éditeur

Les modèles prennent en charge la substitution de paramètres, ce qui permet d'utiliser le même modèle dans différents scénarios spécifiques.


Création d'un modèle

Les modèles sont des fichiers Markdown avec un Frontmatter YAML.

Le nom du fichier (sans .md) est le nom de commande du modèle.

Créer un modèle de revue de code :

Exemple

---
description: Passez en revue les modifications git actuellement indexées
---
Examinez les modifications dans la zone de préparation (git diff --cached), en vous concentrant sur :
- Bogues potentiels et erreurs logiques
- Problèmes de sécurité
- Gestion des erreurs et cas limites
- Problèmes de performance

Enregistrez dans~/.pi/agent/prompts/review.mdEnsuite, tapez dans l'éditeur/reviewpour le développer et l'utiliser.


Emplacement du modèle

Pi Agent recherche des modèles dans plusieurs emplacements fixes, chacun avec une portée différente.

EmplacementPortée
~/.pi/agent/prompts/*.mdModèles globaux, disponibles pour tous les projets
.pi/prompts/*.mdModèles de projet, chargés uniquement une fois le projet approuvé
Le répertoire prompts/ dans les Pi PackagesModèles dans le package
--prompt-template pathChargement temporaire depuis la ligne de commande

La découverte des modèles estnon récursiveLes modèles dans les sous-répertoires prompts/ ne seront pas automatiquement chargés.

Si des modèles sont placés dans des sous-répertoires, vous devez ajouter explicitement le chemin au tableau prompts dans settings.json.


Système de paramètres

Les modèles prennent en charge un système de paramètres riche, permettant au même modèle de s'adapter à différents scénarios :

SyntaxeSignificationExemple
$1, $2, $3...Paramètres positionnels$1 représente le premier paramètre
$@ ou $ARGUMENTSConcaténation de tous les paramètresJoindre tous les paramètres avec des espaces
${1:-default}Paramètre avec une valeur par défautUtiliser le paramètre s'il existe et n'est pas vide, sinon utiliser la valeur par défaut
${@:N}Commencer à partir du Nième paramètre${@:2} prend tous les paramètres à partir du 2e
${@:N:L}Prendre L paramètres à partir du Nième${@:2:3} prend les paramètres 2 à 4

$ARGUMENTS concatène tous les paramètres tels quels, adapté aux modèles qui n'ont besoin que d'un bloc de texte entier :

Exemple

---
description: Traduire un texte chinois en anglais naturel
argument-hint: "<chinois à traduire>"
---
Traduisez le contenu suivant en anglais naturel, n'affichez que la traduction :
$ARGUMENTS

Enregistrez sous~/.pi/agent/prompts/translate.mdUtilisez ensuite/translate pour traduire ce passage en anglaispour l'invoquer.

Exemple de modèle avec paramètres

Le modèle ci-dessous combine des paramètres positionnels et des paramètres de fin, adapté à des entrées telles que "type + nom + description supplémentaire".

Exemple

---
description: Créer un composant en utilisant le framework spécifié
argument-hint: "<framework> <nom-du-composant> [description de la fonctionnalité]"
---
Utilisez $1 pour créer un composant $2, avec des fonctionnalités comprenant : ${@:3}

$1 prend le premier paramètre comme framework, $2 prend le deuxième paramètre comme nom du composant.

${@:3} représente tout le contenu à partir du troisième paramètre, utilisé pour transporter des descriptions de fonctionnalités dispersées.

Utilisation :

/component React Button "onClick 事件处理" "disabled 状态支持" "loading 加载状态"

Résultat de l'expansion :

使用 React 创建一个 Button 组件,功能包括:onClick 事件处理 disabled 状态支持 loading 加载状态

Exemple de valeur par défaut

Lorsque des paramètres sont manquants, les valeurs par défaut servent de solution de repli, de sorte que le modèle fonctionne normalement même lorsqu'il est invoqué sans paramètres.

Exemple

---
description: Résumer l'état actuel du projet
---
Résumer les principaux changements et l'état du projet actuel en ${1:-5} points à puces.

Enregistrez dans~/.pi/agent/prompts/summarize.mdEnsuite, utilisez/summarizepour invoquer.

En utilisant/summarize, on obtient 5 points à puces par défaut.

En utilisant/summarize 10, on obtient 10 points à puces.

Les résultats de l'expansion des deux invocations se comparent comme suit :

/summarize
→ 用 5 个要点总结当前项目的主要变更和状态。

/summarize 10
→ 用 10 个要点总结当前项目的主要变更和状态。

argument-hint Indication de paramètre

Définir dans le Frontmatterargument-hintpeut aider les utilisateurs à comprendre les paramètres dont le modèle a besoin :

Exemple

---
description: Examiner la PR à partir de l'URL, analyser le code et les problèmes
argument-hint: "<PR-URL>"
---
Passez en revue les modifications de code dans la PR suivante, en vous concentrant sur les problèmes de sécurité et de performance : $1

Dans le menu déroulant d'autocomplétion, ce modèle s'affichera comme suit :

→ pr   &lt;PR-URL&gt;  — 从 URL 审查 PR,分析代码和问题

Enregistrez dans~/.pi/agent/prompts/pr-review.mdUtilisez ensuite/pr-review https://github.com/example/repo/pull/12pour l'invoquer.

Utilisez<chevrons>pour les paramètres obligatoires,[crochets]pour les paramètres facultatifs.


Exemples pratiques de modèles

Les trois modèles suivants couvrent les trois types de requêtes les plus courants dans le développement quotidien, et peuvent être copiés et adaptés selon les besoins.

Génération de message de commit Git

Le modèle suivant génère des messages de commit selon la spécification Conventional Commits.

Exemple

---
description: Générer un message de commit conventionnel à partir de git diff
---
Examinez le contenu de git diff --cached et générez un message de commit git conventionnel.
Suivez la spécification Conventional Commits, format : type(scope): description
Les types incluent : feat, fix, refactor, docs, test, chore

Enregistrez dans~/.pi/agent/prompts/commit.mdEnsuite, ajoutez vos modifications à l'index et utilisez/commitpour l'invoquer.

Demande de refactorisation de code

Le modèle suivant décompose les objectifs de refactorisation en éléments de vérification clairs, empêchant l'IA de ne modifier que le formatage sans toucher à la structure.

Exemple

---
description: Refactoriser le module de code spécifié
argument-hint: "<chemin de fichier ou nom de module>"
---
Refactorisez le code de $1, objectifs :
1. Améliorer la lisibilité du code
2. Éliminer le code dupliqué
3. Améliorer la gestion des erreurs
4. Conserver les fonctionnalités existantes inchangées

Avant d'apporter des modifications, veuillez expliquer votre plan de refactorisation.

Enregistrer dans~/.pi/agent/prompts/refactor.mdPuis utiliser/refactor src/utils/date.tspour invoquer.

Demande de correction de bug

Le modèle suivant force l’IA à diagnostiquer en étapes fixes, réduisant la tendance à « modifier le code immédiatement ».

Exemple

---
description: Diagnostiquer et corriger systématiquement le bug spécifié
argument-hint: "<Description du bug>"
---
J’ai besoin que vous m’aidiez à diagnostiquer et corriger le bug suivant : $1

Veuillez suivre ces étapes :
1. Comprendre d’abord le comportement attendu et réel du bug
2. Trouver les fichiers de code pertinents
3. Analyser les causes possibles
4. Proposer un plan de correction
5. Mettre en œuvre la correction
6. Vérifier que le correctif est correct

Expliquez vos conclusions et votre raisonnement à chaque étape.

Enregistrez dans~/.pi/agent/prompts/fix-bug.mdpuis, utilisez/fix-bug La liste ne s'actualise pas après la connexionpour appeler.


Règles de chargement des modèles

La découverte et le chargement des modèles suivent les règles ci-dessous. Si vous dépannez « le modèle n'apparaît pas », vérifiez d'abord ici.

RègleDescription
Découverte non récursiveLa découverte des modèles dans le répertoire prompts/ estnon récursive; les modèles dans les sous-répertoires ne seront pas automatiquement découverts
Les sous-répertoires doivent être déclarés explicitementLorsque vous devez charger des modèles dans un sous-répertoire, ajoutez explicitement le chemin au tableau prompts dans settings.json
repli de descriptionSidescriptionest vide, Pi Agent utilisera la première ligne non vide du fichier comme description
Désactiver la découverte automatiqueVia--no-prompt-templatesla découverte automatique est désactivée, mais les modèles explicitement spécifiés avec--prompt-templateseront toujours chargés

Après avoir entré /template name, s'il n'apparaît pas dans la liste de complétion, vérifiez d'abord si le fichier se trouve dans le répertoire racine prompts/.

Les modèles de projet placés dans .pi/prompts/ doivent également passer d'abord la vérification de confiance du projet, sinon ils ne seront pas chargés non plus.

Autres extensions