ai digest

ai-digest

Un outil CLI pour regrouper votre base de code dans un seul fichier Markdown à utiliser avec les projets Claude ou les ChatGPT personnalisés.

Caractéristiques

• Agrége tous les fichiers dans le répertoire et les sous-répertoires spécifiés

• Ignore les artefacts de build courants et les fichiers de configuration

• Génère un seul fichier Markdown contenant toute la base de code

• Fournit des options pour la suppression des espaces et des modèles d'ignorance personnalisés

Comment utiliser

Commencez par exécuter l'outil CLI dans le répertoire de votre projet :

 npx ai-digest

Cela générera un fichier codebase.md avec votre base de code.

Une fois que vous avez généré le fichier Markdown contenant votre base de code, vous pouvez l'utiliser avec des modèles d'IA comme ChatGPT et Claude pour l'analyse et l'assistance du code.

Avec ChatGPT :

1. Créer un GPT personnalisé

2. Téléchargez le fichier Markdown généré dans la base de connaissances du GPT

Avec Claude :

1. Créer un nouveau projet

2. Ajouter le fichier Markdown à la connaissance du Projet

Pour de meilleurs résultats, téléchargez à nouveau le fichier Markdown avant de démarrer une nouvelle session de discussion pour vous assurer que l'IA dispose de la version la plus à jour de votre base de code.

Possibilités

• -i, --input : Spécifie le répertoire d'entrée (par défaut : répertoire actuel)

• -o, --output : Spécifie le fichier de sortie (par défaut : codebase.md)

• --no-default-ignores : Désactiver les modèles d'ignorance par défaut

• --whitespace-removal : Activer la suppression des espaces

• --show-output-files : Afficher une liste des fichiers inclus dans la sortie

• --ignore-file  : Spécifiez un fichier ignoré personnalisé (par défaut : .aidigestignore)

• --help : Afficher l'aide

Exemples

1. Utilisation de base :

    npx ai-digest

2. Spécifiez l'entrée et la sortie :

    npx ai-digest -i /path/to/your/project -o project_summary.md

3. Activer la suppression des espaces :

    npx ai-digest --whitespace-removal

4. Afficher la liste des fichiers inclus :

    npx ai-digest --show-output-files

5. Combinez plusieurs options :

    npx ai-digest -i /path/to/your/project -o project_summary.md --whitespace-removal --show-output-files

Modèles d'ignorance personnalisés

ai-digest prend en charge les modèles d'ignorance personnalisés à l'aide d'un fichier .aidigestignore dans le répertoire racine de votre projet. Ce fichier fonctionne de manière similaire à .gitignore , vous permettant de spécifier les fichiers et répertoires qui doivent être exclus de l'agrégation.

Utilisez l'indicateur --show-output-files pour voir quels fichiers sont inclus, ce qui facilite l'identification des candidats à l'exclusion.

Suppression des espaces

Lors de l'utilisation de l'indicateur --whitespace-removal , ai-digest supprime les espaces en excès des fichiers pour réduire le nombre de jetons lorsqu'il est utilisé avec des modèles d'IA. Cette fonctionnalité est désactivée pour les langages dépendants des espaces comme Python et YAML.

Gestion des fichiers binaires et SVG

Les fichiers binaires et SVG sont inclus dans la sortie avec une note sur leur type de fichier. Cela permet aux modèles d'IA de connaître ces fichiers sans inclure leur contenu complet.

Développement local

Exécutez npm run start pour exécuter l'outil CLI sur le projet local. (Très méta !)

Exécutez npm test pour exécuter les tests.

Pour transmettre des indicateurs à la CLI, utilisez l'indicateur -- , comme ceci : npm run start -- --whitespace-removal .

Déployer une nouvelle version

npm publish

Contribuer

Les contributions sont les bienvenues ! N'hésitez pas à soumettre une Pull Request.

Licence

Ce projet est sous licence MIT.