Repomix : emballage de la base de code dans un fichier texte pour la récupération de modèles de grande taille

Introduction générale

Repomix (anciennement connu sous le nom de Repopack) est un outil open source conçu pour rassembler l'ensemble d'une base de code en un seul fichier adapté à l'IA. Cet outil permet aux développeurs de rendre facilement leur base de code disponible pour l'analyse et le traitement par de grands modèles de langage tels que Claude, ChatGPT et Gemini. Il a été conçu à l'origine pour simplifier la tâche de l'IA dans la compréhension et la génération de code pour les scénarios qui nécessitent une révision rapide ou un remaniement de la base de code.Repomix prend en charge une variété de formats de sortie, y compris XML, Markdown, et le texte brut, et fournit des profils pour répondre aux besoins de différents projets.

Liste des fonctions

• Emballage de la base de codeLe projet complet est regroupé dans un seul fichier pour faciliter l'analyse de l'IA.
• Prise en charge de la sortie multiformatIl fournit différents formats de sortie tels que XML, Markdown et texte brut, que l'utilisateur peut sélectionner à sa guise.
• Flexibilité de la configurationLe fichier de configuration vous permet de personnaliser des options telles que l'ignorance des fichiers, la suppression des commentaires, etc.
• Soutien aux entrepôts à distanceVous pouvez récupérer et empaqueter du code directement à partir d'un dépôt GitHub distant.
• Support DockerLes images Docker sont fournies pour faciliter l'exécution de Repomix dans un environnement conteneurisé.
• contrôle de sécuritéLes contrôles de sécurité sont activés par défaut afin d'éviter la fuite d'informations sensibles.

Utiliser l'aide

Installation de Repomix

Repomix est un outil basé sur Node.js, vous devez donc vous assurer que Node.js est installé sur votre système.

1.Installation de Node.js: :

• Visitez le site officiel de Node.js pour télécharger et installer la version appropriée à votre système.

2.Installation de Repomix: :

• Installez Repomix globalement via npm :

  npm install -g repomix
  

Utilisation de Repomix

Utilisation de base

• Conditionnement des projets locaux: :
  Allez dans le répertoire de votre projet et exécutez-le :

repomix

Cela génère un fichier dans le répertoire courant appelérepomix-output.xmldu fichier. Si vous devez spécifier le format de sortie, vous pouvez utiliser ** --styleParamètres :

repomix --style markdown

• Emballage Entrepôt à distance: :
  Si vous souhaitez empaqueter directement un dépôt GitHub distant, exécutez :

  repomix --remote https://github.com/yamadashy/repomix
  

  Vous pouvez également spécifier des branches ou des commits spécifiques :

  repomix --remote yamadashy/repomix --remote-branch main
  

fichier de configuration

• Repomix prend en charge des configurations personnalisées qui peuvent être configurées par le biais de l'optionrepomix --initGénérer unrepomix.config.jsonDocument. Vous pouvez y définir
  • Ignorer les fichiers: utiliser **.repomixignoreou le fichier de configuration dans leignorersimilaire à l'option.gitignore**.
  • format de sortieFormat de sortie : Sélectionnez le format du fichier de sortie (par exemple, XML, Markdown).
  • Texte de l'en-têteAjouter un texte explicatif au début du fichier de sortie.
  • contrôle de sécurité: Activer ou non les contrôles de sécurité afin d'éviter la divulgation d'informations sensibles.

  Exemple de fichier de configuration :

  {
  "output": {
  "filePath": "repomix-output.xml",
  "style": "xml",
  "fileSummary": true
  },
  "ignore": {
  "useGitignore": true
  }
  }
  

Exécution de Repomix

• Exécution dans Docker: :
  Si vous préférez utiliser Docker pour gérer votre environnement, vous pouvez le faire :

  docker run -v ./output:/app -it --rm ghcr.io/yamadashy/repomix --remote yamadashy/repomix
  

Repomix pour une utilisation avec d'autres outils d'IA

• Le fichier unique généré peut être téléchargé directement vers des outils d'intelligence artificielle tels que Claude, ChatGPT ou Gemini pour analyse :
  • Examen du codeLes services d'assistance technique : Fournir de la documentation à l'IA qui demande un examen du code ou qui suggère un remaniement.
  • Génération de documentsGénérer de la documentation ou des fichiers README à partir de la base de code.
  • Résolution de problèmesLes tâches sont multiples : identifier les problèmes dans le code et fournir des solutions à l'aide d'outils d'intelligence artificielle.