codebase dump

Readme

Proyek ini adalah versi ringan dari CodeBase Digest, yang dirancang untuk menganalisis dan merangkum basis kode Anda menjadi dump satu file. Output yang dihasilkan meliputi:

• Struktur dan Isi Kode
• Ringkasan dasar basis kode

Output ini dapat digunakan sebagai input untuk model bahasa besar (LLM) seperti ChatGPT, Google Gemini, dan lainnya untuk analisis lebih lanjut atau untuk mendukung tugas berbasis prompt.

Untuk inspirasi tentang kemungkinan permintaan, lihat bagian Prompt LLM di repositori CodeBase Digest.

Cara menggunakan

Instalasi

Opsi 1: Instal via PIP

Anda dapat menginstal codeBase-dump langsung dari PYPI:

pip install codebase-dump

Opsi 2: Instal dengan mengkloning repositori

Repositori Pengaturan Klon

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

Saya merekomendasikan membuka proyek ini dalam kode Visual Studio dan menyiapkan lingkungan virtual.

Penggunaan

Baris perintah

Setelah diinstal, Anda dapat menjalankan codeBase-dump dari baris perintah:

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

Argumen yang tersedia

Pilihan	Keterangan
path_to_directory	Jalur ke direktori yang ingin Anda analisis
-o, --output-format	Format Output (Teks, Markdown). Default: Teks
-f, --file	Nama file output
--max-size	Ukuran konten teks maksimum yang diizinkan di KB (default: 10240 kb)
--ignore-top-large-files	Jumlah file terbesar untuk diabaikan (default: 0)
--audit-upload	Kirim output ke API audit sebagaimana didefinisikan oleh parameter --audit-base-url
--audit-base-url	API Base URL untuk mengirim audit ke (default: https://codeaudits.ai/)
--api-key	Kunci API pribadi Anda untuk menetapkan repositori yang dikirimkan ke akun Anda di https://codeaudits.ai/

Contoh

Hasilkan file markdown dari struktur kode proyek Anda:

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

---

Hasilkan file markdown dan dorong ke aplikasi audit codeaudits.ai:

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

---

Hasilkan file markdown dan dorong ke instance kustom aplikasi audit:

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

---

Hasilkan file penurunan harga sambil mengabaikan 5 file terbesar teratas dan dorong ke audit aplikasi codeaudits.ai:

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

Dari sumber

Anda juga dapat menjalankan codebase-dump langsung dari kode sumber:

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

Coba online dengan Google Colab

Anda dapat mencoba CodeBase-Dump di lingkungan online, Google Colab. Ini bisa menjadi pilihan yang baik jika Anda tidak memiliki lingkungan Python di komputer Anda. Cukup luncurkan di sini: codebase-dump colab. Untuk mengujinya, jalankan semua kode melalui runtime -> jalankan semua.

Penggunaan dalam Tindakan GitHub

Anda dapat mengotomatiskan basis basis kode dalam alur kerja tindakan github untuk menghasilkan dan menyimpan pembuangan kode sebagai artefak. Berikut adalah contoh konfigurasi alur kerja (contoh kerja yang tersedia di repositori ini sendiri: .github/alur kerja/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

Dalam contoh ini:

• Alur kerja dipicu secara manual dengan workflow_dispatch.
• Ini menginstal CodeBase-Dump dan menghasilkan file .md bernama Project_dump_for_llm.md, berisi struktur dan ringkasan kode.
• Bendera --Audit-Upload mengirimkan output ke Audit API di https://codeaudits.ai/
• File yang dihasilkan kemudian diunggah sebagai artefak untuk akses dan unduhan yang mudah.

Apa selanjutnya?

Gunakan sendiri

Setelah Anda mendapatkan dump basis kode Anda, salin ke salah satu LLM sebagai prompt input dan mulailah bertanya pada Gemini, Chatgpt, Claude dan pertanyaan lain yang terkait dengan basis kode Anda. Misalnya, tanyakan tentang "apa yang disarankan langkah untuk refactor kode ini ke // pilihan Anda // arsitektur.".

Untuk inspirasi tentang kemungkinan prompt, periksa bagian LLM Prompts di CodeBase Digest Repository.

Gunakan audit kode

Basis kode parsed juga diunggah ke https://codeaudits.ai/ Aplikasi. Saat Anda meluncurkan tautan yang dikembalikan kepada Anda, Anda dapat menjalankan beberapa audit kode yang telah dikonfigurasi sebelumnya, seperti petunjuk refactoring arsitektur, tes yang hilang atau petunjuk penyederhanaan.