Flatty

Flatty - base de code pour le texte pour LLMS

Transformez n'importe quel repos ou dossier GitHub sur votre Mac en un fichier texte simple afin que vous puissiez le télécharger sur un LLM (Claude, Chatgpt, etc.) pour raisonner dans la fenêtre de contexte.

Base de code → Fichier texte (s)

Les LLM comme Chatgpt et Claude vous permettent de télécharger des fichiers, mais ils limitent le nombre de téléchargements en même temps. Lorsque vous avez affaire à de grandes bases de code qui ont des tonnes de fichiers, vous ne pouvez pas simplement les télécharger directement sur un LLM. Vous finissez par devoir utiliser des techniques de chiffon (récupération de génération augmentée), qui, selon mon expérience, ne sont pas aussi efficaces que de tout télécharger dans la fenêtre de contexte complet - en particulier lorsque vous devez raisonner sur l'architecture ou comprendre l'ensemble du système. Voir l'exemple.

Les assistants de codage comme Cursor sont des Amateballs, mais ils fonctionnent mieux pour l'achèvement du code quotidien et les modifications en ligne que pour la compréhension du système de niveau supérieur.

Caractéristiques

• ALAPPORT DE FICHIER complet: convertit des bases de code entières en fichiers texte structurés adaptés aux LLM.
• Gestion des fichiers intelligents: saute intelligemment les fichiers binaires, les images, la création d'artefacts, les répertoires de packages, les fichiers cachés et les fichiers système.
• ****? Filtrage basé sur le modèle: améliorez votre processus d'aplatissement en incluant sélectivement les fichiers en fonction de modèles de code spécifiques ou de mots clés dans le contenu de fichiers et les noms de fichiers. Personnalisez vos critères d'inclusion en utilisant AND / OR des conditions pour cibler exactement ce dont vous avez besoin pour une analyse ciblée.

Installation

Choisissez votre aventure:

? ‍️ Installation rapide (mode facile)

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

‍️ Installation paranoïaque (chèques de sécurité supplémentaires)

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

L'installation paranoïde (par défaut) inclut la vérification de la somme de contrôle et les vérifications de sécurité complètes. L'installation rapide saute ces contrôles pour la foule "j'aime vivre dangereusement".

Usage

L'utilisation de base est stupidement simple:

 cd your-project-directory
flatty

Cela crée un fichier texte bien formaté dans ~/Documents/flatty/ contenant tous les fichiers texte de votre projet, prêt pour la consommation LLM.

Filtrage basé sur les modèles

Prenez le contrôle de ce qui est inclus dans votre sortie aplatie en spécifiant les modèles et les conditions. Cette fonctionnalité vous permet de vous concentrer sur des parties spécifiques de votre base de code, d'améliorer l'efficacité et la pertinence.

Arguments en ligne de commande:

• --pattern "pattern1" : Spécifiez un modèle ou un mot-clé pour filtrer les fichiers. Vous pouvez utiliser plusieurs drapeaux --pattern pour plusieurs modèles.
• --condition AND|OR : Définissez comment plusieurs modèles doivent être appariés.
  • AND : tous les modèles spécifiés doivent être présents dans un fichier (soit dans le nom de fichier ou le contenu).
  • OR : l'un des modèles spécifiés doit être présent.

Exemples:

1. Inclut des fichiers contenant une async function useEffect ou d'async:

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

2. Inclut les fichiers contenant à la fois une fonction useEffect et async function :

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

3. Inclure des fichiers avec README dans le nom de fichier:

   flatty --pattern " README " --condition OR

4. Comportement par défaut sans modèles (inclut tous les fichiers texte éligibles):

   flatty

Comportement:

• Ou condition: les fichiers sont inclus si l'un des modèles spécifiés est trouvé dans le nom de fichier ou le contenu du fichier.
• Et condition: les fichiers ne sont inclus que si tous les modèles spécifiés sont trouvés dans le nom de fichier ou le contenu de fichier.
• Aucun modèle spécifié: par défaut, incluant tous les fichiers texte éligibles, en maintenant le comportement d'origine.

Gestion des fichiers intelligents

Flatty saute intelligemment:

• Fichiers et images binaires
• Construire des artefacts
• Répertoires de packages ( node_modules , vendor )
• Fichiers cachés et .git
• Fichiers système ( .DS_Store )

Sortir

Les fichiers texte aplatis sont enregistrés dans le répertoire ~/flattened/ avec des noms de fichiers formatés comme:

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

Chaque fichier de sortie comprend:

• Informations et métadonnées du projet
• Structure du référentiel complet avec répertoires et dénombrements de jetons de fichiers
• Contenu de chaque fichier texte inclus, séparé par des séparateurs définis

Développement

Développé avec ❤️ par talktastic

Contributif

Les contributions sont les bienvenues! Veuillez ouvrir un problème ou soumettre une demande de traction pour toute amélioration ou correction de bogues.

Crochets git

Pour maintenir l'intégrité du script flatty.sh et assurer que le fichier de somme de contrôle ( flatty.sh.sha256 ) est toujours à jour, les contributeurs doivent configurer un crochet GIT pré-engagé. Ce crochet génère et met automatiquement à jour la somme de contrôle avant chaque engagement.

Étapes pour configurer le crochet pré-communiqué:

1. Accédez au répertoire Git Hooks:

    cd .git/hooks

2. Créez ou modifiez le crochet pre-commit :

   cursor pre-commit

3. Ajoutez le script suivant au fichier 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. Faire le hook exécutable:

   chmod +x pre-commit

Explication: Ce crochet garantit que chaque fois que flatty.sh est modifié et un commit est fait, le fichier de somme de contrôle flatty.sh.sha256 correspondant est automatiquement mis à jour et inclus dans le commit. Cela maintient le processus de vérification de l'intégrité pour le script d'installation.

Licence

Mit