Repomix

Démarrage rapide ​

Une fois que vous avez généré un fichier compressé (repomix-output.txt) avec Repomix, vous pouvez l'envoyer à un assistant IA avec une instruction comme :

Ce fichier contient tous les fichiers du dépôt combinés en un seul.
Je souhaite refactoriser le code, veuillez donc d'abord l'examiner.

L'IA analysera votre base de code complète et fournira des informations détaillées :

Lors de la discussion de modifications spécifiques, l'IA peut vous aider à générer du code. Avec des fonctionnalités comme les Artefacts de Claude, vous pouvez même recevoir plusieurs fichiers interdépendants :

Bon codage ! 🚀

Guide de l'utilisateur avancé ​

Pour les utilisateurs avancés qui ont besoin de plus de contrôle, Repomix offre de nombreuses options de personnalisation via son interface en ligne de commande.

Démarrage rapide ​

Vous pouvez essayer Repomix instantanément dans votre répertoire de projet sans installation :

npx repomix

Ou l'installer globalement pour une utilisation répétée :

# Installation avec npm
npm install -g repomix

# Alternativement avec yarn
yarn global add repomix

# Alternativement avec Homebrew (macOS/Linux)
brew install repomix

# Puis exécuter dans n'importe quel répertoire de projet
repomix

C'est tout ! Repomix générera un fichier repomix-output.txt dans votre répertoire actuel, contenant l'intégralité de votre dépôt dans un format adapté à l'IA.

Utilisation ​

Pour empaqueter tout votre dépôt :

repomix

Pour empaqueter un répertoire spécifique :

repomix path/to/directory

Pour empaqueter des fichiers ou répertoires spécifiques en utilisant des motifs glob :

repomix --include "src/**/*.ts,**/*.md"

Pour exclure des fichiers ou répertoires spécifiques :

repomix --ignore "**/*.log,tmp/"

Pour empaqueter un dépôt distant :

# Utilisation du format abrégé
npx repomix --remote yamadashy/repomix

# Utilisation de l'URL complète (prend en charge les branches et les chemins spécifiques)
npx repomix --remote https://github.com/yamadashy/repomix
npx repomix --remote https://github.com/yamadashy/repomix/tree/main

# Utilisation de l'URL d'un commit
npx repomix --remote https://github.com/yamadashy/repomix/commit/836abcd7335137228ad77feb28655d85712680f1

Pour initialiser un nouveau fichier de configuration (repomix.config.json) :

repomix --init

Une fois que vous avez généré le fichier compressé, vous pouvez l'utiliser avec des outils d'IA générative comme Claude, ChatGPT et Gemini.

Utilisation avec Docker ​

Vous pouvez également exécuter Repomix avec Docker 🐳
C'est utile si vous souhaitez exécuter Repomix dans un environnement isolé ou préférez utiliser des conteneurs.

Utilisation de base (répertoire courant) :

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

Pour empaqueter un répertoire spécifique :

docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix path/to/directory

Traiter un dépôt distant et sortir vers un répertoire output :

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

Formats de sortie ​

Choisissez votre format de sortie préféré :

# Format XML (par défaut)
repomix --style xml

# Format Markdown
repomix --style markdown

# Format texte brut
repomix --style plain

Personnalisation ​

Créez un repomix.config.json pour des paramètres persistants :

{
  "output": {
    "style": "markdown",
    "filePath": "custom-output.md",
    "removeComments": true,
    "showLineNumbers": true,
    "topFilesLength": 10
  },
  "ignore": {
    "customPatterns": ["*.test.ts", "docs/**"]
  }
}

Plus d'exemples ​