codebase dump

Réadmettre

Ce projet est une version légère de Codebase Digest, conçue pour analyser et résumer votre base de code en un vidage à un seul fichier. La sortie générée comprend:

• Structure du code et contenu
• Un résumé de base de la base de code

Cette sortie peut être utilisée comme entrée pour les modèles de grands langues (LLMS) comme Chatgpt, Google Gemini et autres pour une analyse plus approfondie ou pour prendre en charge les tâches basées sur des tâches.

Pour l'inspiration sur les invites possibles, reportez-vous à la section LLM Invites dans le référentiel de digestion de base.

Comment utiliser

Installation

Option 1: Installer via PIP

Vous pouvez installer CodeBase-Dump directement à partir de PYPI:

pip install codebase-dump

Option 2: Installez en clonage le référentiel

Référentiel de configuration des clones

git clone https://github.com/your-username/codebase-dump.git
cd codebase-dump
pip install -r requirements.txt

Je recommande d'ouvrir ce projet dans Visual Studio Code et de mettre en place un environnement virtuel.

Usage

Ligne de commande

Une fois installé, vous pouvez exécuter du CodeBase-Dump à partir de la ligne de commande:

codebase-dump < path_to_codebase > -f < output_filename > -o < output_format >

Arguments disponibles

Option	Description
path_to_directory	Chemin vers le répertoire que vous souhaitez analyser
-o, --output-format	Format de sortie (texte, marquage). Par défaut: texte
-f, --file	Nom de fichier de sortie
--max-size	Taille maximale du contenu du texte autorisé dans KB (par défaut: 10240 Ko)
--ignore-top-large-files	Nombre de fichiers les plus importants à ignorer (par défaut: 0)
--audit-upload	Envoyez la sortie à l'API Audits tel que défini par le paramètre --audit-base-url
--audit-base-url	URL de base de l'API pour envoyer l'audit à (par défaut: https://codeaudits.ai/)
--api-key	Votre clé API privée pour attribuer un référentiel soumis à votre compte sur https://codeaudits.ai/

Exemples

Générez un fichier Markdown de la structure de code de votre projet:

codebase-dump . -f project_dump_for_llm.md -o markdown

---

Générez un fichier Markdown et poussez-le vers les audits App CodeAudits.ai:

codebase-dump . -o markdown --audit-upload

---

Générez un fichier Markdown et poussez-le vers l'instance personnalisée des audits App:

codebase-dump . -o markdown --audit-upload --audit-base-url https://your-audit-instance.com/

---

Générez un fichier Markdown tout en ignorant les 5 meilleurs fichiers les plus importants et poussez-le vers les audits App CodeAudits.ai:

codebase-dump . -o markdown --audit-upload --ignore-top-large-files=5

De la source

Vous pouvez également exécuter CodeBase-Dump directement à partir du code source:

pip install -e .
python src/codebase_dump/app.py < path_to_codebase > -f < output_filename > -o < output_format >

Essayez en ligne avec Google Colab

Vous pouvez essayer CodeBase-Dump dans un environnement en ligne, Google Colab. Cela peut être une bonne option si vous n'avez pas d'environnement Python sur votre ordinateur. Il suffit de le lancer ici: CodeBase-Dump Colab. Pour le tester, exécutez tout le code via l'exécution -> Exécutez tout.

Utilisation des actions GitHub

Vous pouvez automatiser le Dump de base de code dans un flux de travail GitHub Actions pour générer et enregistrer le vidage de code en artefact. Voici un exemple de configuration de workflow (exemple de travail disponible dans ce propre référentiel: .github / workflows / codebase_dump.yml).

 name : Generate Project Dump for LLM

on :
  workflow_dispatch :

jobs :
  generate-file :
    runs-on : ubuntu-latest

    steps :
      - name : Checkout code
        uses : actions/checkout@v4

      - name : Set up Python
        uses : actions/setup-python@v3
        with :
          python-version : " 3.10 "

      - name : Install codebase-dump
        run : pip install codebase-dump

      - name : Generate Single-File Prompt for LLM
        run : codebase-dump . -f project_dump_for_llm.md -o markdown --audit-upload

      - name : Upload Prompt File as Artifact
        uses : actions/upload-artifact@v3
        with :
          name : project_dump_for_llm.md
          path : project_dump_for_llm.md

Dans cet exemple:

• Le workflow est déclenché manuellement avec Workflow_dispatch.
• Il installe CodeBase-Dump et génère un fichier .md nommé project_dump_for_llm.md, contenant la structure et le résumé du code.
• L'indicateur --audit-upload envoie la sortie à l'API Audits sur https://codeaudits.ai/
• Le fichier généré est ensuite téléchargé en artefact pour un accès et un téléchargement faciles.

Quoi de suivi?

Utilisez-le par vous-même

Une fois que vous avez obtenu votre vidage de base de code, copiez-le dans l'un des LLMS en tant qu'invite d'entrée et commencez à poser des questions Gemini, Chatgpt, Claude et d'autres questions liées à votre base de code. Par exemple, renseignez-vous sur "Quelles sont les étapes suggérées pour refacter ce code dans // votre choix // architecture.".

Pour l'inspiration sur les invites possibles, vérifiez la section des invites LLM dans le référentiel de digestion de base.

Utiliser des audits de code

La base de code analysée a également été téléchargée sur l'application https://codeaudits.ai/. Lorsque vous lancez le lien qui vous a été renvoyé, vous pouvez exécuter des audits de code préconfigurés, comme des conseils de refactorisation d'architecture, des tests manquants ou des conseils de simplification.