หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

AI-ย่อย

เครื่องมือ CLI เพื่อรวมโค้ดเบสของคุณให้เป็นไฟล์ Markdown ไฟล์เดียวสำหรับใช้กับ Claude Projects หรือ ChatGPT แบบกำหนดเอง

คุณสมบัติ

  • รวมไฟล์ทั้งหมดในไดเร็กทอรีและไดเร็กทอรีย่อยที่ระบุ

  • ละเว้นการสร้างทั่วไปและไฟล์การกำหนดค่า

  • ส่งออกไฟล์ Markdown ไฟล์เดียวที่มีโค้ดเบสทั้งหมด

  • มีตัวเลือกสำหรับการลบช่องว่างและรูปแบบการละเว้นแบบกำหนดเอง

วิธีใช้

เริ่มต้นด้วยการเรียกใช้เครื่องมือ CLI ในไดเร็กทอรีโปรเจ็กต์ของคุณ:

 npx ai-ย่อย

สิ่งนี้จะสร้างไฟล์ codebase.md ด้วย codebase ของคุณ

เมื่อคุณสร้างไฟล์ Markdown ที่มี codebase ของคุณแล้ว คุณสามารถใช้มันกับโมเดล AI เช่น ChatGPT และ Claude เพื่อการวิเคราะห์และช่วยเหลือโค้ดได้

ด้วย ChatGPT:

  1. สร้าง GPT ที่กำหนดเอง

  2. อัปโหลดไฟล์ Markdown ที่สร้างขึ้นไปยังฐานความรู้ของ GPT

กับคลอดด์:

  1. สร้างโครงการใหม่

  2. เพิ่มไฟล์ Markdown ให้กับความรู้ของโครงการ

เพื่อให้ได้ผลลัพธ์ที่ดีที่สุด ให้อัปโหลดไฟล์ Markdown อีกครั้งก่อนที่จะเริ่มเซสชันการแชทใหม่เพื่อให้แน่ใจว่า AI มีโค้ดเบสเวอร์ชันล่าสุดของคุณ

ตัวเลือก

  • -i, --input : ระบุไดเร็กทอรีอินพุต (ค่าเริ่มต้น: ไดเร็กทอรีปัจจุบัน)

  • -o, --output : ระบุไฟล์เอาต์พุต (ค่าเริ่มต้น: codebase.md)

  • --no-default-ignores : ปิดการใช้งานรูปแบบการละเว้นเริ่มต้น

  • --whitespace-removal : เปิดใช้งานการลบช่องว่าง

  • --show-output-files : แสดงรายการไฟล์ที่รวมอยู่ในเอาต์พุต

  • --ignore-file : ระบุไฟล์ละเว้นที่กำหนดเอง (ค่าเริ่มต้น: .aidigestignore)

  • --help : แสดงความช่วยเหลือ

ตัวอย่าง

  1. การใช้งานขั้นพื้นฐาน:

     npx ai-ย่อย

  2. ระบุอินพุตและเอาต์พุต:

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

  3. เปิดใช้งานการลบช่องว่าง:

     npx ai-digest -- การลบช่องว่าง

  4. แสดงรายการไฟล์ที่รวมอยู่:

     npx ai-digest --show-output-files

  5. รวมหลายตัวเลือก:

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

รูปแบบการละเว้นแบบกำหนดเอง

ai-digest รองรับรูปแบบการละเว้นแบบกำหนดเองโดยใช้ไฟล์ .aidigestignore ในไดเร็กทอรีรากของโปรเจ็กต์ของคุณ ไฟล์นี้ทำงานคล้ายกับ .gitignore ซึ่งช่วยให้คุณระบุไฟล์และไดเร็กทอรีที่ควรแยกออกจากการรวม

ใช้แฟล็ก --show-output-files เพื่อดูว่าไฟล์ใดบ้างที่ถูกรวมไว้ ทำให้ง่ายต่อการระบุตัวเลือกที่จะแยกออกได้ง่ายขึ้น

การกำจัดช่องว่าง

เมื่อใช้แฟล็ก --whitespace-removal นั้น ai-digest จะลบช่องว่างส่วนเกินออกจากไฟล์ เพื่อลดจำนวนโทเค็นเมื่อใช้กับโมเดล AI คุณลักษณะนี้ถูกปิดใช้งานสำหรับภาษาที่ขึ้นกับช่องว่าง เช่น Python และ YAML

การจัดการไฟล์ไบนารีและ SVG

ไฟล์ไบนารีและ SVG จะรวมอยู่ในเอาต์พุตพร้อมหมายเหตุเกี่ยวกับประเภทไฟล์ ซึ่งช่วยให้โมเดล AI สามารถรับรู้ไฟล์เหล่านี้ได้โดยไม่ต้องรวมเนื้อหาทั้งหมด

การพัฒนาท้องถิ่น

รัน npm run start เพื่อรันเครื่องมือ CLI บนโปรเจ็กต์โลคัล (เมตามาก!)

รัน npm test เพื่อรันการทดสอบ

หากต้องการส่งผ่านแฟล็กไปยัง CLI ให้ใช้ -- แฟล็ก เช่นนี้: npm run start -- --whitespace-removal

ปรับใช้เวอร์ชันใหม่ 

npm publish

มีส่วนร่วม

ยินดีบริจาค! โปรดส่งคำขอดึง

ใบอนุญาต

โครงการนี้ได้รับอนุญาตภายใต้ใบอนุญาต MIT

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด