Flatty

Flatty-CodeBase-to-Text para LLMS

Transforme cualquier repositorio o carpeta de GitHub en su Mac en un archivo de texto simple para que pueda cargarlo en un LLM (Claude, ChatGpt, etc.) para razonar todo en la ventana de contexto.

CodeBase → Archivos de texto (s) de texto (s)

LLMS como ChatGPT y Claude le permiten subir archivos, pero limitan cuántos pueden cargar a la vez. Cuando se trata de grandes bases de código que tienen toneladas de archivos, no puede simplemente cargarlos directamente a un LLM. Terminas teniendo que usar técnicas RAG (recuperación de generación aumentada), que en mi experiencia no son tan efectivas como cargar todo en la ventana de contexto completa, especialmente cuando necesitas razonar sobre la arquitectura o comprender todo el sistema. Ver ejemplo.

Los asistentes de codificación como el cursor son los asombrosos, pero funcionan mejor para la finalización del código diario y las ediciones en línea que para la comprensión del sistema de nivel superior.

Características

• Aplanador de archivos integral: convierte las bases de código enteras en archivos de texto estructurados adecuados para LLM.
• Manejo de archivos inteligentes: omita de manera inteligente archivos binarios, imágenes, crea artefactos, directorios de paquetes, archivos ocultos y archivos del sistema.
• ****? Filtrado basado en patrones: mejore su proceso de aplanamiento mediante la inclusión selectiva de archivos basados ​​en patrones de código específicos o palabras clave tanto en el contenido del archivo como en los nombres de archivo. Personalice sus criterios de inclusión utilizando AND / OR condiciones para apuntar exactamente a lo que necesita para un análisis enfocado.

Instalación

Elige tu aventura:

? ‍️ Instalación rápida (modo fácil)

curl -fsSL https://raw.githubusercontent.com/mattmireles/flatty/main/install_flatty.sh | bash -s -- --quick

‍️ Instalación paranoica (comprobaciones de seguridad adicionales)

curl -fsSL https://raw.githubusercontent.com/mattmireles/flatty/main/install_flatty.sh | bash

La instalación paranoica (predeterminada) incluye verificación de suma de verificación y verificaciones de seguridad completas. La instalación rápida omite estos cheques para la multitud "me gusta vivir peligrosamente".

Uso

El uso básico es estúpidamente simple:

 cd your-project-directory
flatty

Esto crea un archivo de texto bien formateado en ~/Documents/flatty/ que contiene todos los archivos de texto de su proyecto, listo para el consumo de LLM.

Filtrado basado en patrones

Tome el control de lo que se incluye en su salida aplanada especificando patrones y condiciones. Esta característica le permite centrarse en partes específicas de su base de código, mejorando la eficiencia y la relevancia.

Argumentos de línea de comandos:

• --pattern "pattern1" : especifique un patrón o palabra clave para filtrar archivos. Puede usar múltiples banderas --pattern para múltiples patrones.
• --condition AND|OR : Definir cómo se deben combinar múltiples patrones.
  • AND : todos los patrones especificados deben estar presentes en un archivo (ya sea en el nombre de archivo o contenido).
  • OR : cualquiera de los patrones especificados debe estar presente.

Ejemplos:

1. Incluya archivos que contienen la función useEffect o async function :

   flatty --pattern " useEffect " --pattern " async function " --condition OR

2. Incluya archivos que contienen la función useEffect y async function :

   flatty --pattern " useEffect " --pattern " async function " --condition AND

3. Incluya archivos con README en el nombre de archivo:

   flatty --pattern " README " --condition OR

4. Comportamiento predeterminado sin patrones (incluye todos los archivos de texto elegibles):

   flatty

Comportamiento:

• O condición: los archivos se incluyen si alguno de los patrones especificados se encuentra en el nombre de archivo o el contenido del archivo.
• Y condición: los archivos se incluyen solo si todos los patrones especificados se encuentran en el nombre de archivo o el contenido del archivo.
• Sin patrones especificados: el valor predeterminado incluye todos los archivos de texto elegibles, manteniendo el comportamiento original.

Manejo de archivos inteligentes

Flatty se salta inteligentemente:

• Archivos e imágenes binarios
• Construir artefactos
• Directorios de paquetes ( node_modules , vendor )
• Archivos ocultos y .git
• Archivos del sistema ( .DS_Store )

Producción

Los archivos de texto aplanados se guardan en el directorio ~/flattened/ con nombres de archivo formateados como:

 <project-name>-v<version>-<timestamp>.txt

Cada archivo de salida incluye:

• Información y metadatos del proyecto
• Estructura de repositorio completa con directorios y recuentos de tokens de archivo
• Contenido de cada archivo de texto incluido, separado por separadores definidos

Desarrollo

Desarrollado con ❤️ por TalkTastic

Que contribuye

¡Las contribuciones son bienvenidas! Abra un problema o envíe una solicitud de extracción de mejoras o correcciones de errores.

Gits gits

Para mantener la integridad del script flatty.sh y asegurarse de que el archivo de suma de verificación ( flatty.sh.sha256 ) esté siempre actualizado, los contribuyentes deben configurar un gancho GIT anterior a Commit. Este gancho genera automáticamente y actualiza la suma de verificación antes de cada confirmación.

Pasos para configurar el gancho precomito:

1. Navegue al directorio Git Hooks:

    cd .git/hooks

2. Crear o editar el gancho pre-commit :

   cursor pre-commit

3. Agregue el siguiente script al archivo pre-commit :

    #! /bin/bash
   
   # Generate SHA256 checksum for flatty.sh
   sha256sum flatty.sh > flatty.sh.sha256
   
   # Add the checksum file to the commit
   git add flatty.sh.sha256

4. Hacer ejecutable del gancho:

   chmod +x pre-commit

Explicación: Este gancho garantiza que cada vez que se modifique flatty.sh y se realiza un confirmación, el archivo correspondiente flatty.sh.sha256 se actualiza automáticamente e incluye en la confirmación. Esto mantiene el proceso de verificación de integridad para el script de instalación.

Licencia

MIT