OpenAI Codex CLI : un assistant de codage de l'IA en ligne de commande de terminal lancé par OpenAI

Introduction générale

OpenAI Codex CLI est un outil de codage de terminal open source développé par OpenAI pour les développeurs habitués à utiliser des terminaux. Codex CLI utilise les derniers modèles d'OpenAI (tels que o3 et o4-mini), prend en charge la programmation multilingue et fournit un environnement sandbox sécurisé qui restreint l'accès au réseau et la manipulation des répertoires pour garantir la sécurité. Le projet est entièrement open source, encourage les contributions de la communauté et convient au développement rapide, à l'automatisation des tâches et à l'apprentissage de la programmation.

Liste des fonctions

• Génération de code : génère du code multilingue tel que Python, JavaScript, etc. sur la base du langage naturel.
• Opérations sur les fichiers : création et modification de fichiers, prise en charge des commits et des versions Git.
• Exécution de commandes : exécuter du code ou des commandes dans le bac à sable et afficher les résultats en temps réel.
• Saisie multimodale : prise en charge des captures d'écran et des graphiques pour générer le code correspondant.
• Security Sandbox (bac à sable de sécurité) : désactive le réseau par défaut et n'exploite que le répertoire actuel pour des raisons de sécurité.
• Approbation automatisée : trois modes sont possibles : manuel, édition automatique et entièrement automatisé.
• Développement open source : permet aux utilisateurs de visualiser le code, de soumettre des contributions PR.
• Documentation de projet : prise en charge des commandes Markdown globales et au niveau du projet, comportement personnalisé.

Utiliser l'aide

Processus d'installation

Pour utiliser l'interface de programmation Codex, suivez les étapes d'installation suivantes :

1. exigences du système: :
   • OS : macOS 12+, Ubuntu 20.04+/Debian 10+, ou Windows 11 (via WSL2).
   • Node.js : version >= 22 (version LTS recommandée).
   • Git : version >= 2.23 (recommandé, pour le contrôle de version).
   • RAM : au moins 4 Go, 8 Go recommandés.
   • Clé API OpenAI : Obtenez-la sur le site web de l'OpenAI.
2. Étapes de l'installation: :
   • Installer globalement via npm (recommandé) :

     npm install -g @openai/codex
     

   • ou construire à partir du code source :

     git clone https://github.com/openai/codex.git
     cd codex/codex-cli
     npm install
     npm run build
     

   • Définir la clé de l'API :

     export OPENAI_API_KEY="your-api-key-here"
     

     Pour un réglage permanent, ajoutez-le au fichier de configuration de l'interpréteur de commandes (par ex. ~/.zshrc peut-être ~/.bashrc) :

     echo 'export OPENAI_API_KEY="your-api-key-here"' >> ~/.zshrc
     source ~/.zshrc
     

   • Vérifier l'installation :

     codex --help
     

     Si le message d'aide s'affiche, l'installation a réussi.

3. Configuration de Linux Docker: :
   • Docker est recommandé pour une meilleure sécurité :

     ./run_in_container.sh
     

   • Assurez-vous que Docker est installé, le script montera automatiquement le répertoire courant et configurera le pare-feu pour autoriser uniquement l'accès à l'API OpenAI.
4. mise en garde: :
   • Ne pas utiliser sudo npm install -gdevrait corriger les permissions de npm :

     sudo chown -R $(whoami) ~/.npm
     

   • Assurez-vous que la clé API est valide afin d'éviter 401 peut-être 429 Erreur.

Utilisation

Codex CLI offre une expérience de codage efficace en combinant le langage naturel et l'environnement sandbox par le biais d'opérations de commande de terminal. Voici comment utiliser les principales fonctionnalités :

1. génération de codes

• flux de travail: :
  • Modèles d'interaction :

    codex
    

    Saisissez une invite telle que "Créer une fonction Python pour calculer une série de Fibonacci".

  • Mode à commande unique :

    codex "生成 JavaScript 过滤数组函数"
    

  • Codex CLI génère du code et affiche un aperçu.
  • importation y Accepter et sauvegarder, entrer n Rejet.
• Options avancées: :
  • Spécifier le modèle :

    codex --model o4-mini "生成 Go HTTP 服务器"
    

  • Mode non interactif :

    codex -q "生成 SQL 查询" > output.sql
    

• Fonctions vedettes: :
  • Prise en charge de Python, JavaScript, TypeScript, Go, SQL et plus encore.
  • Peut gérer des tâches complexes telles que "Générer une application Flask avec authentification de l'utilisateur".

2. manipulation de fichiers et intégration de Git

• flux de travail: :
  • Modifier le fichier :

    codex "在 src/app.js 中添加登录功能"
    

  • Le CLI Codex affiche les différences de code, les confirme et les enregistre.
  • S'engager dans Git :

    codex "提交更改，消息为 '添加登录功能'"
    

• Fonctions vedettes: :
  • Gérer automatiquement les commandes Git (add,commit).
  • Prend en charge les opérations par lots telles que :

    codex "重命名所有 *.jpeg 为 *.jpg 并更新引用"
    

  • Trois modes d'approbation sont prévus :
    • suggestPar défaut, toutes les modifications doivent être confirmées manuellement.
    • auto-editLes modifications apportées au fichier sont appliquées automatiquement et la commande doit être confirmée.
    • full-autoLe système est entièrement automatique et doit être utilisé avec précaution :

      codex --approval-mode full-auto "更新 README"
      

3. exécuter le code

• flux de travail: :
  • Exécuter le code :

    codex "运行 src/main.py"
    

  • Le CLI Codex s'exécute dans le bac à sable et affiche les résultats.
  • Si une dépendance est manquante, il faut l'installer :

    codex "安装 numpy 并运行 script.py"
    

• Fonctions vedettes: :
  • macOS utilise le bac à sable Apple Seatbelt et Linux utilise Docker.
  • Les réseaux sont désactivés par défaut pour éviter tout accès accidentel.
  • Prise en charge de la sortie de débogage pour afficher les détails de l'erreur.

4. les entrées multimodales

• flux de travail: :
  • Saisir le chemin d'accès à l'image :

    codex "根据 ui.png 实现界面代码"
    

  • Codex CLI analyse les images pour générer du code HTML/CSS ou du code frontal.
• Fonctions vedettes: :
  • Aide à la conversion de la conception de l'interface utilisateur en code.
  • Les diagrammes ou organigrammes peuvent être traités pour générer un code logique.

5. configuration et personnalisation

• fichier de configuration: :
  • Configuration globale :~/.codex/config.yaml: :

    model: o4-mini
    fullAutoErrorMode: ask-user
    

  • Fichier d'instructions :~/.codex/instructions.md: :

    - 使用 Python 3.9
    - 禁止自动提交 Git
    

  • Configuration au niveau du projet : le codex.md: :

    - 优先使用 TypeScript
    - 运行测试前执行 npm run lint
    

• Désactiver la documentation du projet: :

  codex --no-project-doc

• Changement de mode d'approbation: :

  codex --approval-mode auto-edit
  

6. intégration CI/CD

• flux de travail: :
  • Exécutez-le dans GitHub Actions :

    - name: 更新文档
    run: |
    npm install -g @openai/codex
    export OPENAI_API_KEY="${{ secrets.OPENAI_KEY }}"
    codex -a auto-edit -q "更新 CHANGELOG"
    

  • Régler le mode silencieux :

    export CODEX_QUIET_MODE=1
    

• Fonctions vedettes: :
  • Prend en charge le mode non interactif, adapté aux processus automatisés.
  • Produit des sorties au format JSON pour faciliter l'écriture de scripts :

    codex -q --json "生成配置"
    

mise en garde

• Assurez-vous que le répertoire est suivi par Git.full-auto émettra un avertissement dans les répertoires non Git.
• Vérifiez le quota de la clé API, des appels fréquents peuvent déclencher des limites.
• Le projet est expérimental et peut avoir des fonctionnalités instables, nous recommandons donc de suivre GitHub pour les mises à jour.

scénario d'application

1. Prototypage rapide
   Les développeurs peuvent rapidement générer des cadres de code en langage naturel. Par exemple, tapez "Créer une application Express avec une base de données" et le CLI Codex génère des itinéraires, des modèles et des fichiers de configuration adaptés à la validation des idées.
2. Tâches automatisées
   Codex CLI simplifie les tâches répétitives telles que "mettre à jour les notices de copyright dans tous les fichiers et les soumettre". Il édite automatiquement les fichiers, exécute les scripts et pousse vers Git pour les opérations par lots.
3. Programmation de l'apprentissage
   Les débutants peuvent taper "Tri rapide en Python", Codex CLI génère le code et explique la logique, ce qui convient à l'auto-apprentissage ou à l'enseignement en classe.
4. Collaboration Open Source
   Les développeurs peuvent participer au développement de Codex CLI via GitHub, soumettre des corrections de bogues ou de nouvelles fonctionnalités, et la base de code transparente facilite la collaboration.
5. Pipeline CI/CD
   Dans les environnements CI, l'interface Codex CLI peut automatiquement mettre à jour la documentation, générer des cas de test ou corriger des bogues pour un développement plus efficace.

QA

1. En quoi le Codex CLI diffère-t-il du modèle Codex 2021 ?
   Le Codex CLI est un outil plus puissant et open source basé sur les derniers modèles OpenAI (o3, o4-mini), indépendant des modèles Codex qui seront abandonnés en 2021.
2. Comment assurer la sécurité des opérations ?
   La CLI Codex s'exécute par défaut dans un bac à sable, utilise Apple Seatbelt pour macOS et Docker pour Linux, désactive le réseau et restreint l'accès aux répertoires afin d'éviter tout risque pour le système.
3. Quels sont les langages de programmation pris en charge ?
   Python, JavaScript, TypeScript, Go, SQL, etc. sont pris en charge, selon le modèle OpenAI utilisé, et le langage peut être spécifié via une commande.
4. L'interface de programmation Codex est-elle gratuite ?
   Le CLI Codex lui-même est gratuit, mais nécessite une clé API OpenAI et peut entraîner des coûts pour les appels API, voir OpenAI Pricing pour plus de détails.
5. Comment empêcher le CLI Codex de modifier les fichiers ?
   utiliser suggest tous les changements doivent être confirmés manuellement :

   codex --approval-mode suggest