codebase dump
v0.6.0
โครงการนี้เป็น Codebase Digest เวอร์ชันที่มีน้ำหนักเบาออกแบบมาเพื่อวิเคราะห์และสรุป codebase ของคุณลงในการถ่ายโอนไฟล์เดียว เอาต์พุตที่สร้างขึ้นรวมถึง:
เอาต์พุตนี้สามารถใช้เป็นอินพุตสำหรับรุ่นภาษาขนาดใหญ่ (LLM) เช่น Chatgpt, Google Gemini และอื่น ๆ สำหรับการวิเคราะห์เพิ่มเติมหรือสนับสนุนงานตามพรอมต์
สำหรับแรงบันดาลใจในการแจ้งเตือนที่เป็นไปได้โปรดดูที่ส่วน LLM Prompts ในที่เก็บข้อมูล Digest Codebase
คุณสามารถติดตั้ง codebase-dump ได้โดยตรงจาก PYPI:
pip install codebase-dumpที่เก็บการตั้งค่าโคลน
git clone https://github.com/your-username/codebase-dump.git
cd codebase-dump
pip install -r requirements.txtฉันขอแนะนำให้เปิดโครงการนี้ใน Visual Studio Code และตั้งค่าสภาพแวดล้อมเสมือนจริง
เมื่อติดตั้งแล้วคุณสามารถเรียกใช้ codebase-dump จากบรรทัดคำสั่ง:
codebase-dump < path_to_codebase > -f < output_filename > -o < output_format >| ตัวเลือก | คำอธิบาย |
|---|---|
path_to_directory | เส้นทางสู่ไดเรกทอรีที่คุณต้องการวิเคราะห์ |
-o, --output-format | รูปแบบเอาต์พุต (ข้อความ, markdown) ค่าเริ่มต้น: ข้อความ |
-f, --file | ชื่อไฟล์เอาต์พุต |
--max-size | ขนาดเนื้อหาข้อความที่อนุญาตสูงสุดใน KB (ค่าเริ่มต้น: 10240 KB) |
--ignore-top-large-files | จำนวนไฟล์ที่ใหญ่ที่สุดที่จะละเว้น (ค่าเริ่มต้น: 0) |
--audit-upload | ส่งเอาต์พุตไปยัง API การตรวจสอบตามที่กำหนดโดย-พารามิเตอร์ --audit-base-url |
--audit-base-url | API Base URL เพื่อส่งการตรวจสอบไปยัง (ค่าเริ่มต้น: https://codeaudits.ai/) |
--api-key | คีย์ API ส่วนตัวของคุณเพื่อกำหนดที่เก็บที่ส่งไปยังบัญชีของคุณใน https://codeaudits.ai/ |
สร้างไฟล์ markdown ของโครงสร้างรหัสโครงการของคุณ:
codebase-dump . -f project_dump_for_llm.md -o markdownสร้างไฟล์ markdown และส่งไปยังแอพตรวจสอบ codeaudits.ai:
codebase-dump . -o markdown --audit-uploadสร้างไฟล์ Markdown และส่งไปยังอินสแตนซ์ที่กำหนดเองของแอพตรวจสอบ:
codebase-dump . -o markdown --audit-upload --audit-base-url https://your-audit-instance.com/สร้างไฟล์ Markdown ในขณะที่ไม่สนใจไฟล์ที่ใหญ่ที่สุด 5 อันดับแรกและส่งไปยังแอพตรวจสอบ CodeAudits.ai:
codebase-dump . -o markdown --audit-upload --ignore-top-large-files=5คุณยังสามารถเรียกใช้ CodeBase-Dump ได้โดยตรงจากซอร์สโค้ด:
pip install -e .
python src/codebase_dump/app.py < path_to_codebase > -f < output_filename > -o < output_format >คุณสามารถลอง Codebase-Dump ในสภาพแวดล้อมออนไลน์ Google Colab อาจเป็นตัวเลือกที่ดีถ้าคุณไม่มีสภาพแวดล้อม Python ในคอมพิวเตอร์ของคุณ เพิ่งเปิดตัวที่นี่: codebase-dump colab หากต้องการทดสอบให้เรียกใช้รหัสทั้งหมดผ่านรันไทม์ -> เรียกใช้ทั้งหมด
คุณสามารถทำให้ Codebase-Dump เป็นอัตโนมัติในเวิร์กโฟลว์การกระทำของ GitHub เพื่อสร้างและบันทึกรหัสการถ่ายโอนข้อมูลเป็นสิ่งประดิษฐ์ นี่คือตัวอย่างการกำหนดค่าเวิร์กโฟลว์ (ตัวอย่างการทำงานที่มีอยู่ในที่เก็บนี้: .github/เวิร์กโฟลว์/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ในตัวอย่างนี้:
เมื่อคุณได้รับการถ่ายโอนข้อมูล codebase ของคุณแล้วให้คัดลอกลงใน LLMS เป็นหนึ่งในนั้นเป็นพรอมต์อินพุตและเริ่มถาม Gemini, Chatgpt, Claude และคำถามอื่น ๆ ที่เกี่ยวข้องกับ codebase ของคุณ ตัวอย่างเช่นถามเกี่ยวกับ "ขั้นตอนที่แนะนำเพื่อ refactor รหัสนี้เป็น // ตัวเลือกของคุณ // สถาปัตยกรรม"
สำหรับแรงบันดาลใจในการแจ้งเตือนที่เป็นไปได้ให้ตรวจสอบส่วน LLM แจ้งในพื้นที่เก็บข้อมูล Digest Codebase
Parsed Codebase ถูกอัปโหลดไปยัง https://codeaudits.ai/ แอปพลิเคชัน เมื่อคุณเปิดลิงค์ที่ส่งคืนให้คุณคุณสามารถเรียกใช้การตรวจสอบรหัสที่กำหนดค่าล่วงหน้าได้เช่นคำแนะนำการปรับเปลี่ยนสถาปัตยกรรมการทดสอบที่ขาดหายไปหรือคำแนะนำการทำให้เข้าใจง่าย
