Codex Conseils de prompting de la CLI

Maîtriser des techniques de prompt efficaces est essentiel pour tirer le meilleur parti de Codex CLI. Cette section détaille comment écrire des prompts efficaces pour obtenir les meilleurs résultats.


Bases des prompts

Vous interagissez avec Codex en envoyant des invites qui décrivent la tâche que vous souhaitez qu'il accomplisse.

Exemples de base

Invite de base

# Expliquer la fonctionnalité du code
"Expliquez comment fonctionne le module transform et comment les autres modules l'utilisent."

# Ajouter une nouvelle fonctionnalité
"Ajouter une nouvelle option de ligne de commande `--json` qui produit du JSON."

# Corriger un bug
"Corrigez l'erreur dans la fonction login"

Fonctionnement des invites

Lorsque vous soumettez une invite, Codex fonctionne selon la boucle suivante :

Codex 提示词工作流程
Figure : flux de travail des invites Codex
  1. Appeler le modèle de langage
  2. Exécuter les opérations indiquées par la sortie du modèle (lire des fichiers, modifier des fichiers, exécuter des outils, etc.)
  3. Répéter jusqu'à ce que la tâche soit terminée ou que vous annuliez
Comprendre cette boucle vous aide à mieux concevoir des prompts, car Codex prend des décisions en fonction du contexte à chaque étape.

Conseils pour rédiger des prompts efficaces

Astuce 1 : Inclure des étapes de vérification

Codex produit une sortie de meilleure qualité lorsqu'il peut vérifier son travail. L'inclusion d'étapes de vérification aide Codex à garantir l'exactitude :

Prompt avec vérification

# Non recommandé
"Écrire une fonction pour trier une liste"

# Recommandé - inclure une vérification
"Écrire une fonction pour trier une liste. Inclure des cas de test pour vérifier qu'elle gère les listes vides, les listes déjà triées, les listes triées en ordre inverse et les listes avec des doublons. Exécuter les tests pour confirmer qu'ils réussissent."

Astuce 2 : Décomposer les tâches complexes en petites étapes

Codex est plus performant sur des tâches plus petites et ciblées. Les petites tâches sont plus faciles à tester et à relire :

Découpage des tâches

# Non recommandé - tâche trop grande
"Créer un système complet d'authentification utilisateur avec connexion, inscription, réinitialisation de mot de passe et OAuth"

# Recommandé - décomposer en petites étapes
"Étape 1 : Créer un modèle utilisateur avec des champs email et password
Étape 2 : Ajouter un endpoint d'inscription
Étape 3 : Ajouter un endpoint de connexion avec JWT
Étape 4 : Ajouter la fonctionnalité de réinitialisation de mot de passe
Prévenez-moi lorsque l'étape 1 est terminée avant de passer à l'étape 2"

Astuce 3 : Fournir du contexte

Fournissez un contexte que Codex peut utiliser, comme des références à des fichiers et images pertinents :

Fournir du contexte

# Non recommandé
"Corrigez ce bug"

# Recommandé - incluez des informations détaillées
"Corrigez le bug dans src/auth.py où les utilisateurs ne peuvent pas se connecter avec des caractères spéciaux dans leur mot de passe. J'ai joint une capture d'écran du message d'erreur et de la section de code pertinente."

Astuce 4 : Spécifiez le format de sortie

Indiquez à Codex le format de sortie que vous attendez :

Spécifier le format de sortie

# Spécifiez le style de code
"Écrivez une fonction pour calculer les nombres de Fibonacci. Utilisez TypeScript, incluez des commentaires JSDoc et suivez les principes de programmation fonctionnelle."

# Spécifiez la structure de sortie
"Expliquez la structure de la base de code. Organisez votre réponse avec : 1) Vue d'ensemble 2) Répertoires clés 3) Points d'entrée principaux"
Des prompts plus spécifiques produisent généralement de meilleurs résultats. Codex est bon pour comprendre l'intention, mais plus vous fournissez d'informations, mieux il fonctionne.

Fils de discussion

Un fil de discussion est une seule conversation : vos prompts, ainsi que les sorties du modèle et les appels d'outils qui suivent. Un fil de discussion peut contenir plusieurs prompts.

Fils de discussion locaux vs Fils de discussion cloud

TypeAperçuAvantages
Fils de discussion locauxS'exécutent sur votre machinePeuvent lire et écrire des fichiers, utiliser des outils existants
Fils de discussion cloudS'exécutent dans un environnement isoléS'exécutent en parallèle, délèguent des tâches depuis d'autres appareils

Reprise des conversations

Reprise d'une conversation précédente

# Ouvrir le sélecteur de session
codex resume

# Accéder directement à la session la plus récente
codex resume --last

# Reprendre une session spécifique
codex resume <SESSION_ID>

Gestion des conversations

Les threads en cours d'exécution peuvent s'exécuter en parallèle, mais évitez que deux threads modifient le même fichier en même temps. Vous pouvez également reprendre un thread plus tard en continuant avec un autre prompt.


Gestion du contexte

Lorsque vous soumettez un prompt, incluez du contexte que Codex peut utiliser, comme des références à des fichiers et images pertinents. L'extension IDE inclut automatiquement la liste des fichiers ouverts et la plage de texte sélectionnée comme contexte.

Fenêtre de contexte

Toutes les informations d'un thread doivent tenir dans la fenêtre de contexte du modèle. Codex surveille et signale l'espace restant.

Compactage automatique

Pour les tâches plus longues, Codex peut automatiquement compacter le contexte en résumant les informations pertinentes et en écartant les détails moins pertinents. Codex peut continuer à gérer des tâches complexes sur plusieurs étapes.

Gestion manuelle du contexte

Vous pouvez aider Codex à gérer le contexte des manières suivantes :

  • Concentrez-vous sur la tâche en cours
  • Évitez de mélanger plusieurs tâches indépendantes dans un seul prompt
  • Démarrez régulièrement une nouvelle session (en utilisant/new)
Lorsque Codex signale une utilisation élevée du contexte, envisagez de démarrer une nouvelle session ou de réduire les messages historiques.

Conseils avancés sur les prompts

Utilisation du mode plan

Pour les tâches complexes, utilisez le mode plan pour laisser Codex planifier avant d'exécuter :

Mode plan

# Utilisez la commande /plan
/plan implémenter un système d'authentification utilisateur

# Ou incluez "plan" dans l'invite
"Planifier et implémenter une API REST avec des opérations CRUD pour un blog"

Utilisation du mode Review

Demandez à Codex de réviser le code au lieu de le modifier directement :

Mode Révision

# Utilisez la commande /review
/review src/auth.py

# Ou décrivez l'exigence de révision
"Examinez ce code pour détecter d'éventuelles vulnérabilités de sécurité et proposez des améliorations"

Limiter la portée des modifications

Indiquez clairement à Codex ce qu'il peut modifier :

Limiter la portée des modifications

# Mode lecture seule
"Expliquez ce que fait cette fonction, n'apportez aucune modification"

# Restreindre la portée des fichiers
"journalisation uniquement dans le module auth, ne touchez pas aux autres fichiers"

# Confirmation étape par étape
"Faites-moi connaître les modifications proposées avant de les effectuer"

Modèles de prompts

Voici quelques modèles de prompts courants :

Génération de code

Write a [语言] function that [功能描述].
Requirements:
- [需求1]
- [需求2]
Include:
- 详细的文档注释
- 错误处理
- 测试用例

Revue de code

Review the [文件/模块] for:
- Potential bugs
- Security issues
- Performance problems
- Code style violations

Provide:
- Issue list with severity
- Suggested fixes
- Overall quality score (1-10)

Correction de bug

Fix the bug in [文件:行号/函数名].
Error: [错误信息]
Expected behavior: [期望行为]
Steps to reproduce: [复现步骤]

Refactorisation

Refactor [文件/函数] to [目标].
Current issues:
- [问题1]
- [问题2]

Constraints:
- 保持功能不变
- 不要改变 API 接口
- 添加单元测试
C'est en forgeant qu'on devient forgeron. Entraînez-vous souvent à rédiger des prompts, et vous apprendrez progressivement à obtenir les meilleurs résultats.

FAQ

Q : Que faire si Codex ne comprend pas mon prompt ?

Essayez : 1) Décrivez plus précisément 2) Fournissez plus de contexte 3) Décomposez-le en étapes plus petites 4) Utilisez des exemples pour illustrer le résultat attendu

⟦⟧Q : Les prompts doivent-ils être en anglais ou en chinois ?

Codex prend en charge plusieurs langues. L'anglais fonctionne généralement mieux. Si vous décrivez en chinois, assurez-vous que la description est suffisamment détaillée et claire.

Q : Comment puis-je faire en sorte que Codex analyse uniquement le code sans le modifier ?

Dites-lui clairement « lecture seule » ou « ne faites aucune modification », et il fournira uniquement une analyse sans rien modifier.

Q : Que faire si la fenêtre de contexte est pleine ?

Démarrez une nouvelle session (avec /new), ou laissez Codex compacter l'historique (il s'en chargera automatiquement).

Autres extensions