For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Navigation principale
Theme
Codex

Codex use case

Créer une CLI que Codex peut utiliser

Donnez à Codex une commande qu’il peut combiner avec d’autres pour travailler avec une API, une source de logs, un export ou un script de l’équipe.

Difficulty Intermediate
Time horizon 1h

Demandez à Codex de créer une CLI qu’il pourra exécuter depuis n’importe quel dossier, combiner avec les scripts du dépôt et utiliser pour télécharger des fichiers. Un skill associé lui rappellera comment s’en servir.

Best for

  • Tâches récurrentes où Codex travaille avec le même service, le même export, la même archive locale ou le même script du dépôt pour rechercher, lire ou télécharger des données, ou encore écrire des données en toute sécurité.
  • Outils pour agents qui ont besoin de résultats de recherche paginés, d’un accès direct à un élément par identifiant, de sorties JSON de structure prévisible, de fichiers téléchargés, d’index locaux ou de commandes qui préparent un brouillon avant toute écriture.

Contents

    ← All use cases

    Créer une CLI que Codex peut utiliser

    Donnez à Codex une commande qu’il peut combiner avec d’autres pour travailler avec une API, une source de logs, un export ou un script de l’équipe.

    Demandez à Codex de créer une CLI qu’il pourra exécuter depuis n’importe quel dossier, combiner avec les scripts du dépôt et utiliser pour télécharger des fichiers. Un skill associé lui rappellera comment s’en servir.

    Intermediate
    1h

    Demandez à Codex de créer une CLI qu’il pourra exécuter depuis n’importe quel dossier, combiner avec les scripts du dépôt et utiliser pour télécharger des fichiers. Un skill associé lui rappellera comment s’en servir.

    Intermediate
    1h

    Best for

    • Tâches récurrentes où Codex travaille avec le même service, le même export, la même archive locale ou le même script du dépôt pour rechercher, lire ou télécharger des données, ou encore écrire des données en toute sécurité.
    • Outils pour agents qui ont besoin de résultats de recherche paginés, d’un accès direct à un élément par identifiant, de sorties JSON de structure prévisible, de fichiers téléchargés, d’index locaux ou de commandes qui préparent un brouillon avant toute écriture.

    Skills & Plugins

    • Définissez les commandes, développez la CLI et ajoutez les vérifications de configuration et d’authentification. Installez ensuite la commande dans un répertoire du PATH et testez-la depuis un autre dossier.
    • Créez le skill associé pour indiquer à Codex quelles commandes de la CLI exécuter en premier lors de ses prochaines tâches et quelles opérations d’écriture nécessitent une approbation.
    Skill Why use it
    Cli Creator Définissez les commandes, développez la CLI et ajoutez les vérifications de configuration et d’authentification. Installez ensuite la commande dans un répertoire du PATH et testez-la depuis un autre dossier.
    Skill Creator Créez le skill associé pour indiquer à Codex quelles commandes de la CLI exécuter en premier lors de ses prochaines tâches et quelles opérations d’écriture nécessitent une approbation.

    Starter prompt

    Utilisez $cli-creator pour créer une CLI dont vous pourrez vous servir, puis $skill-creator pour créer le skill associé dans cette même discussion. Source de référence : [URL de la documentation, spécification OpenAPI, commande curl dont les données sensibles ont été masquées, chemin d’un script existant, dossier de logs, export CSV ou JSON, chemin d’une base de données SQLite ou sortie de --help collée ici]. Première tâche à prendre en charge : [télécharger les logs d’un build CI en échec à partir de son URL, rechercher des tickets d’assistance et en lire un à partir de son identifiant, interroger une API d’administration, lire une base de données locale ou exécuter une étape d’un script existant]. Opération d’écriture facultative : [préparer un brouillon de commentaire, téléverser des fichiers multimédias, relancer une tâche qui a échoué ou rester en lecture seule pour le moment]. Nom de la commande : [cli-name, ou proposez un nom]. Avant de coder, présentez-moi les commandes que vous proposez. Demandez-moi uniquement les précisions sans lesquelles vous ne pourriez pas développer la CLI.
    Utilisez $cli-creator pour créer une CLI dont vous pourrez vous servir, puis $skill-creator pour créer le skill associé dans cette même discussion. Source de référence : [URL de la documentation, spécification OpenAPI, commande curl dont les données sensibles ont été masquées, chemin d’un script existant, dossier de logs, export CSV ou JSON, chemin d’une base de données SQLite ou sortie de --help collée ici]. Première tâche à prendre en charge : [télécharger les logs d’un build CI en échec à partir de son URL, rechercher des tickets d’assistance et en lire un à partir de son identifiant, interroger une API d’administration, lire une base de données locale ou exécuter une étape d’un script existant]. Opération d’écriture facultative : [préparer un brouillon de commentaire, téléverser des fichiers multimédias, relancer une tâche qui a échoué ou rester en lecture seule pour le moment]. Nom de la commande : [cli-name, ou proposez un nom]. Avant de coder, présentez-moi les commandes que vous proposez. Demandez-moi uniquement les précisions sans lesquelles vous ne pourriez pas développer la CLI.

    Introduction

    Si Codex utilise régulièrement la même API, la même source de journaux, le même export de boîte de réception, la même base de données locale ou le même script d’équipe, donnez-lui une commande dédiée. Codex pourra l’exécuter depuis n’importe quel dossier, examiner et filtrer ses résultats, puis la combiner avec git, gh, rg, des tests et les scripts du dépôt.

    Ajoutez un skill qui précise quand Codex doit utiliser la CLI, quelle commande exécuter en premier, comment limiter le volume des résultats, où retrouver les fichiers téléchargés et quelles commandes d’écriture nécessitent une approbation.

    Dans ce workflow, $cli-creator aide Codex à créer la commande. $skill-creator l’aide à enregistrer un skill réutilisable, comme $ci-logs, que Codex pourra appeler par son nom lors de futures tâches.

    Mode d’emploi

    Définissez ce que la CLI doit faire

    Commencez par définir ce que vous voulez que Codex fasse avant de choisir une technologie. Une bonne CLI transforme une opération récurrente en une commande que Codex peut exécuter depuis n’importe quel dépôt : lire, rechercher, télécharger, exporter, préparer un brouillon, envoyer un fichier, vérifier périodiquement un état ou écrire des données en toute sécurité.

    Situation Ce que Codex peut faire avec la CLI
    Les journaux de CI sont accessibles depuis la page du build. À partir de l’URL du build, télécharger les journaux des jobs en échec dans ./logs et renvoyer les chemins des fichiers avec de courts extraits.
    Les tickets d’assistance arrivent dans un export hebdomadaire. Indexer le dernier export CSV ou JSON, effectuer une recherche par client ou par expression et lire un ticket à partir de son identifiant stable.
    Une réponse d’API est trop volumineuse pour la fenêtre de contexte. Lister uniquement les champs nécessaires, lire l’objet entier à partir de son identifiant et exporter la réponse complète dans un fichier.
    Un export Slack contient de longs fils de discussion. Limiter la recherche avec --limit, lire un fil et renvoyer les messages qui entourent le résultat plutôt que l’archive entière.
    Un script d’équipe enchaîne quatre étapes distinctes. Prévoir des commandes distinctes pour la configuration, la découverte des ressources, le téléchargement, la préparation de brouillons, l’envoi de fichiers, les vérifications périodiques et l’écriture sur le système cible.
    Un plugin trouve l’enregistrement, mais Codex a besoin d’un fichier. Garder le plugin dans la discussion et utiliser une CLI pour télécharger la pièce jointe, la trace, le rapport, la vidéo ou l’archive de journaux et en renvoyer le chemin.

    Fournissez la documentation, les fichiers ou les commandes

    Donnez à Codex une source concrète sur laquelle s’appuyer : de la documentation, une spécification OpenAPI, une commande curl dont vous avez masqué les données sensibles, le chemin d’un export ou d’une base de données, un dossier de journaux ou un script existant. Si vous souhaitez que la CLI reprenne des conventions familières, collez un court extrait de la sortie de --help pour gh, kubectl ou un outil de votre équipe.

    Si la commande nécessite une authentification, indiquez à Codex le nom de la variable d’environnement, le chemin du fichier de configuration ou la procédure de connexion à prendre en charge. Renseignez vous-même le secret dans votre shell ou votre fichier de configuration. Ne collez aucun secret dans la discussion. Demandez à Codex de faire en sorte que la vérification de la configuration de la CLI échoue avec un message clair si les informations d’authentification manquent.

    Demandez à Codex de créer la CLI et le skill

    Utilisez le prompt de départ proposé sur cette page. Précisez la source sur laquelle Codex doit s’appuyer et la première tâche que la CLI doit permettre d’accomplir.

    Avant d’écrire le code, Codex doit vous présenter les commandes envisagées et vous demander uniquement les précisions indispensables à leur mise en œuvre.

    Vérifiez que la commande fonctionne depuis n’importe quel dossier

    Codex doit poursuivre les tests après avoir exécuté cargo run, python path/to/script.py ou une commande d’un paquet qui n’a pas été installé. Demandez-lui de tester la commande installée depuis un autre dépôt ou un dossier temporaire, dans les conditions où il l’utilisera lors d’une future tâche.

    Testez la CLI comme le ferait un agent lors d’une future tâche

    Testez [cli-name] comme vous l’utiliseriez lors d’une future tâche. Montrez-moi que : - command -v [cli-name] aboutit depuis un dossier situé en dehors du dossier du code source de la CLI - [cli-name] --help explique les principales commandes - la vérification de la configuration et de l’authentification s’exécute - une commande sans risque permet de découvrir, de lister ou de rechercher des ressources - une commande de lecture ciblée fonctionne avec un identifiant obtenu à l’étape précédente - pour chaque journal, export, trace ou charge utile de grande taille, la CLI enregistre les données dans un fichier et en renvoie le chemin - les commandes qui écrivent sur le système cible ne sont exécutées que si j’ai explicitement approuvé leur exécution Lisez ensuite le skill associé et donnez-moi le prompt le plus court à utiliser la prochaine fois que j’aurai besoin de cette CLI.

    Si Codex renvoie un énorme bloc de JSON, demandez-lui de limiter le contenu de la réponse par défaut et d’ajouter une option pour exporter les données complètes dans un fichier. S’il oublie quelles commandes nécessitent une approbation, demandez-lui de mettre à jour le skill associé avant de le réutiliser pour une autre tâche.

    Réutilisez le skill

    Lorsque vous aurez de nouveau besoin de la CLI, appelez le skill au lieu de coller une nouvelle fois la documentation :

    Utilisez $ci-logs pour télécharger les journaux des jobs en échec à partir de cette URL de build et indiquez-moi la première étape qui échoue.
    Utilisez $support-export pour rechercher les réclamations de cette semaine concernant des remboursements et lire les trois tickets portant sur les montants les plus élevés.
    Utilisez $admin-api pour trouver l’espace de travail de cet utilisateur, lire sa fiche de facturation et préparer en toute sécurité un brouillon de note pour son compte.

    Pour une tâche récurrente, testez le skill une fois dans une discussion, puis demandez à Codex de planifier depuis cette discussion une tâche qui appellera le skill avec le même prompt.

    Related use cases