الوصف
codebase-snapshot هي أداة مصممة لتحويل مستودع الشيفرة إلى مجموعة من الأجزاء الجاهزة لنماذج اللغة، مع الالتزام بميزانية بايت صارمة. تعالج الأداة التحديات المرتبطة بتغذية مستودعات كبيرة لنماذج اللغة، حيث يمكن أن تكون الملفات كبيرة جدًا والنوافذ السياقية صغيرة جدًا. تعمل الأداة بشكل حتمي، مما يضمن مخرجات متسقة عبر التشغيلات للمدخلات غير المتغيرة.
قراءة المزيد
تدور الوظيفة الأساسية حول إنشاء دليل `snapshot/` يحتوي على أجزاء نصية بسيطة. كل جزء محدود بسقف `maxPartBytes`؛ يتم تقصير الملفات التي تتجاوز هذه الميزانية مع علامات حذف صريحة. بالنسبة للملفات الكبيرة جدًا، توفر مقتطفات من البداية/النهاية. إلى جانب أجزاء الشيفرة، تنشئ ملف `manifest.json`. يعمل هذا البيان كفهرس شامل، حيث يسرد كل ملف مدرج مع تفاصيل مثل طبقته، نوعه، لغته، جزئه، تجزئته، وملخص هيكلي. من المهم أيضًا أنه يسجل كل ملف مستبعد مع السبب المحدد لاستبعاده، مثل `gitignore`، `ملف حساس`، أو `ثنائي`.
تعتبر ميزة رئيسية للحفاظ على سلامة السياق هي أمر `validate`. يعيد هذا الأمر تجزئة المستودع مقابل اللقطة المولدة ويخرج برمز غير صفري إذا تم اكتشاف أي انحراف. يضمن ذلك أن يظل سياق نموذج اللغة حديثًا ودقيقًا، مما يمنع النماذج من العمل مع شيفرة قديمة. تم تصميم الأداة لتكون آمنة بشكل افتراضي، حيث تتخطى ملفات الاعتماد ما لم يُطلب ذلك صراحة، وتقوم بإخفاء السلاسل ذات الشكل السري، وتمنع الحذف العرضي للشيفرة المصدرية من خلال رفض الكتابة فوق الأدلة التي لم تنشئها.
يدعم codebase-snapshot مجموعة واسعة من لغات البرمجة والأطر، بما في ذلك TypeScript، JavaScript، Python، Go، Rust، Java/Kotlin، C#/.NET، PHP، Ruby، C/C++، Vue، Svelte، Astro، Next.js، Nuxt، Remix، Angular، Solid، NestJS، Express، Fastify، Koa، Django، FastAPI، Flask، Laravel، وRails، غالبًا دون الحاجة إلى تكوين. يوفر 25 إعدادًا تلقائيًا تساهم في الطبقات، الأنواع، أنماط التجاهل البيئية، وميزانيات الأجزاء الموصى بها. بالنسبة للغات غير TypeScript، ينشئ ملخصات للاستيراد/التصدير/الفئة/الدالة، مع تصنيفها كـ `ast`، `هيكلية`، أو `استدلالية` للإشارة إلى موثوقيتها.
بعيدًا عن التفاعل البشري، تم بناء codebase-snapshot لوكلاء الذكاء الاصطناعي. يوفر عقدة قابلة للقراءة بواسطة الآلة ومهارة قابلة للتثبيت، مما يسمح للوكلاء بقيادة العملية بالكامل بشكل مستقل. يمكن للوكلاء استخدام أوامر مثل `generate`، `validate`، `report`، و`explain` لإدارة اللقطات، والتحقق من الانحراف، وتدقيق الأسرار، وفهم تضمينات/استبعادات الملفات. تدعم الأداة أيضًا الوصول البرمجي عبر API للتكامل في أنظمة أكبر. تغطي الوثائق الشاملة الخاصة بها التثبيت، مرجع CLI، التكوين، مخطط مخرجات اللقطة، وأدلة لاستخدامها بفعالية مع نماذج اللغة مثل ChatGPT، Claude، وCursor.
- الفئةمساعدو البرمجة بالذكاء الاصطناعي
- نموذج التسعيرمجاني
- النشرCLI, Programmatic API
- المنصاتNode.js 18+
الميزات الأساسية لـ codebase-snapshot
توليد لقطات حتمية
ميزانية بايت صارمة للأجزاء
فهرس شامل manifest.json
التحقق من الانحراف مع أمر `validate`
الكشف التلقائي عن 25 إعداد مشروع
دعم لعدة لغات برمجة وأطر
إخفاء الأسرار واستبعاد الملفات الحساسة
عقدة قابلة للقراءة بواسطة الآلة لوكلاء الذكاء الاصطناعي
مهارة قابلة للتثبيت للوكلاء
وصول برمجي عبر API
تقارير وتدقيق مفصل
إعداد موجه للتشغيل الأول
فنادق مخرجات قابلة للتكوين
معالجة محدودة الذاكرة للملفات الكبيرة
مقارنة اللقطات مع أمر `diff`
كيفية استخدام codebase-snapshot؟
التثبيت: استخدم npm أو yarn أو pnpm أو bun لتثبيت `codebase-snapshot` عالميًا أو كاعتماد مشروع.
البدء السريع: قم بتشغيل `snapshot` في دليل مشروعك للحصول على تشغيل أول موجه أو توليد تلقائي.
التكوين: استخدم أمر `init` لإعداد تفاعلي يكتب ملف `snapshot.config.ts` ذاتي التوثيق.
توليد اللقطة: نفذ `snapshot generate` لإنشاء دليل اللقطة الجاهز لنماذج اللغة.
التحقق من اللقطة: قم بتشغيل `snapshot validate` لمقارنة اللقطة مع المستودع الحالي والتحقق من الانحراف.
شرح المسارات: استخدم `snapshot explain <path>` لفهم سبب تضمين ملف معين أو تخطيه أو مكانه.
تقارير التدقيق: توليد `snapshot report` لمقاييس الصحة، تفاصيل الطبقة، وتدقيق الأسرار.
حالات استخدام codebase-snapshot
- توليد سياق نموذج اللغة
- تحليل الشيفرة بواسطة وكيل الذكاء الاصطناعي
- أتمتة مراجعة الشيفرة
- توجيه المطورين الجدد
- إدارة نافذة السياق
- تدقيق مستودع الشيفرة
- ضمان حداثة السياق
- مقارنة بين المستودعات
