Repomix: empaquetado de la base de código en un archivo de texto para la recuperación de modelos de gran tamaño.

Introducción general

Repomix (antes conocido como Repopack) es una herramienta de código abierto diseñada para empaquetar todo un código base en un único archivo apto para IA. Esta herramienta permite a los desarrolladores poner fácilmente su código base a disposición de grandes modelos lingüísticos como Claude, ChatGPT y Gemini para su análisis y procesamiento. Fue diseñada originalmente para simplificar la tarea de la IA en la comprensión y generación de código para escenarios que requieren una rápida revisión o refactorización de la base de código.Repomix soporta una variedad de formatos de salida, incluyendo XML, Markdown y texto plano, y proporciona perfiles para satisfacer las necesidades de diferentes proyectos.

Lista de funciones

• Embalaje de la base de códigoEmpaqueta todo el proyecto en un único archivo para facilitar el análisis de IA.
• Salida multiformato: Proporciona varios formatos de salida, como XML, Markdown y texto sin formato, que el usuario puede seleccionar a su gusto.
• Flexibilidad de configuración: A través del archivo de configuración, puede personalizar opciones como ignorar archivos, eliminar comentarios, etc.
• Asistencia remota al almacénPuede obtener y empaquetar código directamente desde un repositorio remoto de GitHub.
• Soporte DockerSe proporcionan imágenes Docker para facilitar la ejecución de Repomix en un entorno de contenedores.
• control de seguridad: Los controles de seguridad están activados por defecto para evitar la fuga de información sensible.

Utilizar la ayuda

Instalación de Repomix

Repomix es una herramienta basada en Node.js, por lo que tendrás que asegurarte de que tienes Node.js instalado en tu sistema.

1.Instalación de Node.js::

• Visite el sitio web oficial de Node.js para descargar e instalar la versión adecuada para su sistema.

2.Instalación de Repomix::

• Instale Repomix globalmente a través de npm:

  npm install -g repomix
  

Uso de Repomix

Uso básico

• Empaquetar proyectos locales::
  Vaya al directorio de su proyecto y ejecútelo:

repomix

Esto generará un archivo en el directorio actual llamadorepomix-salida.xmldel archivo. Si necesita especificar el formato de salida, puede utilizar ** --styleParámetros:

repomix --style markdown

• Embalaje Almacén a distancia::
  Si quieres empaquetar directamente un repositorio remoto de GitHub, ejecuta:

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

  También puede especificar ramas o commits concretos:

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

archivo de configuración

• Repomix admite configuraciones personalizadas que pueden configurarse mediante la funciónrepomix --initGenerar unrepomix.config.jsonDocumento. Puede definir en él:
  • Ignorar archivosUtilizar **.repomixignoreo archivo de configuración en elignoresimilar a la opción.gitignore**.
  • formato de salida: Seleccione el formato del archivo de salida (por ejemplo, XML, Markdown).
  • Texto de cabecera: Añade un texto explicativo al principio del archivo de salida.
  • control de seguridad: Si se activan los controles de seguridad para evitar la divulgación de información sensible.

  Ejemplo de fichero de configuración:

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

Ejecutar Repomix

• Ejecución en Docker::
  Si prefiere utilizar Docker para gestionar su entorno, puede hacerlo:

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

Repomix para su uso con otras herramientas de IA

• El archivo único generado puede cargarse directamente en herramientas de IA como Claude, ChatGPT o Gemini para su análisis:
  • Revisión del código: Proporcionar documentación a la IA solicitando una revisión del código o sugiriendo refactorizaciones.
  • Generación de documentosGenerar documentación o archivos README basados en el código base.
  • Resolución de problemas: Identificar problemas en el código y aportar soluciones mediante herramientas de IA.