الصفحة الرئيسية>المتعلقة بالبرمجة>شفرة المصدر الأخرى
تنزيل

ai-digest

أداة CLI لتجميع قاعدة التعليمات البرمجية الخاصة بك في ملف Markdown واحد للاستخدام مع Claude Projects أو ChatGPTs المخصصة.

سمات

  • تجميع كافة الملفات في الدليل المحدد والأدلة الفرعية

  • يتجاهل عناصر البناء وملفات التكوين الشائعة

  • يُخرج ملف Markdown واحدًا يحتوي على قاعدة التعليمات البرمجية بأكملها

  • يوفر خيارات لإزالة المسافات البيضاء وأنماط التجاهل المخصصة

كيفية الاستخدام

ابدأ بتشغيل أداة CLI في دليل مشروعك:

 npx ai-digest

سيؤدي هذا إلى إنشاء ملف codebase.md مع قاعدة التعليمات البرمجية الخاصة بك.

بمجرد إنشاء ملف Markdown الذي يحتوي على قاعدة التعليمات البرمجية الخاصة بك، يمكنك استخدامه مع نماذج الذكاء الاصطناعي مثل ChatGPT وClaude لتحليل التعليمات البرمجية والمساعدة.

مع ChatGPT:

  1. قم بإنشاء GPT مخصص

  2. قم بتحميل ملف Markdown الذي تم إنشاؤه إلى قاعدة معارف GPT

مع كلود:

  1. إنشاء مشروع جديد

  2. أضف ملف Markdown إلى معرفة المشروع

للحصول على أفضل النتائج، أعد تحميل ملف Markdown قبل بدء جلسة دردشة جديدة للتأكد من أن الذكاء الاصطناعي لديه أحدث إصدار من قاعدة التعليمات البرمجية الخاصة بك.

خيارات

  • -i, --input : تحديد دليل الإدخال (الافتراضي: الدليل الحالي)

  • -o, --output : تحديد ملف الإخراج (الافتراضي: codebase.md)

  • --no-default-ignores : تعطيل أنماط التجاهل الافتراضية

  • --whitespace-removal : تمكين إزالة المسافة البيضاء

  • --show-output-files : عرض قائمة بالملفات المضمنة في الإخراج

  • --ignore-file : حدد ملف تجاهل مخصص (الافتراضي: .aidigestignore)

  • --help : عرض المساعدة

أمثلة

  1. الاستخدام الأساسي:

     npx ai-digest

  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 بإزالة المسافات البيضاء الزائدة من الملفات لتقليل عدد الرموز المميزة عند استخدامها مع نماذج الذكاء الاصطناعي. يتم تعطيل هذه الميزة للغات التي تعتمد على المسافات البيضاء مثل Python وYAML.

التعامل مع الملفات الثنائية وSVG

يتم تضمين الملفات الثنائية وملفات SVG في المخرجات مع ملاحظة حول نوع الملف الخاص بها. يتيح ذلك لنماذج الذكاء الاصطناعي أن تكون على علم بهذه الملفات دون تضمين محتواها الكامل.

التنمية المحلية

قم بتشغيل npm run start لتشغيل أداة CLI على المشروع المحلي. (ميتا جدا!)

قم بتشغيل npm test لإجراء الاختبارات.

لتمرير العلامات إلى واجهة سطر الأوامر، استخدم العلامة -- ، كما يلي: npm run start -- --whitespace-removal .

نشر الإصدار الجديد 

npm publish

المساهمة

المساهمات هي موضع ترحيب! لا تتردد في تقديم طلب السحب.

رخصة

هذا المشروع مرخص بموجب ترخيص MIT.

يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل