codebase dump

Readme

Dieses Projekt ist eine leichte Version von Codebase Digest, mit der Ihre Codebasis analysiert und zusammenfasst. Die generierte Ausgabe enthält:

• Codestruktur und Inhalt
• Eine grundlegende Zusammenfassung der Codebasis

Diese Ausgabe kann als Eingabe für große Sprachmodelle (LLMs) wie ChatGPT, Google Gemini und andere für weitere Analysen oder zur Unterstützung von Aufgaben mit basierten Aufgaben verwendet werden.

Inspiration für mögliche Eingabeaufforderungen finden Sie im Abschnitt LLM -Eingabeaufforderungen im Codebase -Digest -Repository.

Wie man benutzt

Installation

Option 1: Installieren Sie über PIP

Sie können Codebasis-Dump direkt von PYPI installieren:

pip install codebase-dump

Option 2: Installation durch Klonen des Repositorys

Clone Setup Repository

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

Ich empfehle, dieses Projekt im Visual Studio -Code zu eröffnen und eine virtuelle Umgebung einzurichten.

Verwendung

Befehlszeile

Nach der Installation können Sie Codebasis-Dump aus der Befehlszeile ausführen:

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

Verfügbare Argumente

Option	Beschreibung
path_to_directory	Pfad zum Verzeichnis, das Sie analysieren möchten
-o, --output-format	Ausgabeformat (Text, Markdown). Standard: Text
-f, --file	Dateinamen ausgeben
--max-size	Maximum zulässige Textinhaltsgröße in KB (Standard: 10240 KB)
--ignore-top-large-files	Anzahl der größten Dateien zu ignorieren (Standard: 0)
--audit-upload	Senden Sie die Ausgabe an die Audits-API gemäß dem Parameter von --audit-base-url
--audit-base-url	API -Basis -URL zum Senden des Audits an (Standard: https://codeaudits.ai/)
--api-key	Ihr privater API -Schlüssel zum Zuweisen eines über eingereichten Repositorys auf Ihr Konto unter https://codeaudits.ai/

Beispiele

Generieren Sie eine Markdown -Datei der Codestruktur Ihres Projekts:

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

---

Generieren Sie eine Markdown -Datei und drücken Sie sie in die Audits App CodeAudits.ai:

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

---

Generieren Sie eine Markdown -Datei und drücken Sie sie auf die benutzerdefinierte Instanz von Audits App:

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

---

Generieren Sie eine Markdown -Datei und ignorieren Sie die Top 5 größten Dateien und geben Sie sie in die Audits App CodeAudits.ai:

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

Von Quelle

Sie können Codebasis-Dump auch direkt aus dem Quellcode ausführen:

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

Probieren Sie online mit Google Colab aus

Sie können Codebase-Dump in einer Online-Umgebung, Google Colab, ausprobieren. Es kann eine gute Option sein, wenn Sie keine Python -Umgebung auf Ihrem Computer haben. Starten Sie es einfach hier: Codebase-Dump Colab. Führen Sie den gesamten Code über Laufzeit aus -> alles aus. Führen Sie alles aus.

Verwendung in Github -Aktionen

Sie können Codebasis-Dump in einem GitHub-Aktions-Workflow automatisieren, um den Code-Dump als Artefakt zu generieren und zu speichern. Hier ist eine Beispiel -Workflow -Konfiguration (Arbeitsbeispiel in diesem eigenen Repository: .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

In diesem Beispiel:

• Der Workflow wird manuell mit Workflow_Dispatch ausgelöst.
• Es installiert Codebasis-Dump und generiert eine .md-Datei mit dem Namen project_dump_for_llm.md, die die Codestruktur und die Zusammenfassung enthält.
• Das Flag-Audit-Upload sendet die Ausgabe an die Audits-API unter https://codeaudits.ai/
• Die generierte Datei wird dann als Artefakt für einfachen Zugriff und Download hochgeladen.

Was als nächstes?

Verwenden Sie es selbst

Sobald Sie Ihren Codebasis -Dump erhalten haben, kopieren Sie diese in einen von LLMs als Eingabeaufforderung und fragen Sie Gemini, Chatgpt, Claude und andere Fragen, die sich auf Ihre Codebasis beziehen. Fragen Sie beispielsweise nach "Was sind vorgeschlagene Schritte, um diesen Code in // Ihre Wahl zu überarbeiten // Architektur.".

Inspiration für mögliche Eingabeaufforderungen finden Sie im Abschnitt LLM -Eingabeaufforderungen im Codebasis -Digest -Repository.

Verwenden Sie Code -Audits

Parsed Codebase wurde auch auf https://codeaudits.ai/ Application hochgeladen. Wenn Sie den Link starten, der an Sie zurückgegeben wurde, können Sie einige vorkonfigurierte Code-Audits wie Architecture Refactoring-Hinweise, fehlende Tests oder Einfachungshinweise ausführen.