Skip to content

Latest commit

 

History

History
185 lines (131 loc) · 9.86 KB

File metadata and controls

185 lines (131 loc) · 9.86 KB

npm npm downloads GitHub stars License

Node.js 18+ npm 8+ TypeScript 3-step workflow

English | 中文 | 日本語 | العربية

حزمة CLI الرسمية لـ OSpec هي @clawplays/ospec-cli، والأمر الرسمي هو ospec. يدعم OSpec أسلوب التطوير المعتمد على المواصفات (SDD) والتطوير المعتمد على الوثائق لوكلاء البرمجة بالذكاء الاصطناعي وتدفقات العمل المعتمدة على CLI.

دليل البرومبت | الاستخدام | نظرة عامة | التثبيت | الإضافات الخارجية | نشر الإضافات | Issues

لماذا OSpec؟

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

  • اتفق قبل كتابة الكود: اجعل proposal و tasks و state و verification و review ظاهرة داخل المستودع
  • اجعل كل متطلب صريحا: المسار الافتراضي ينقل متطلبا واحدا عبر active change واحد
  • ابق خفيفا: يحافظ التدفق اليومي على مسار قصير init -> change -> verify/finalize
  • استخدم المساعدات التي لديك بالفعل: OSpec مصمم لـ Codex و Claude Code وسير عمل CLI المباشر

التثبيت باستخدام npm

npm install -g @clawplays/ospec-cli

الحزمة الرسمية: @clawplays/ospec-cli
الأمر الرسمي: ospec
التحقق من التثبيت: ospec --help

البداية السريعة

استخدام OSpec يتطلب 3 خطوات فقط:

  1. تهيئة OSpec داخل مجلد المشروع
  2. إنشاء تغيير واحد ودفعه إلى الأمام لمتطلب أو تحديث مستندات أو إصلاح خلل
  3. أرشفة التغيير المعتمد بعد اكتمال النشر والتحقق

1. تهيئة OSpec داخل مجلد المشروع

البرومبت الموصى به:

OSpec، هيّئ هذا المشروع.

وضع المهارة في Claude / Codex:

/ospec هيّئ هذا المشروع.
سطر الأوامر
ospec init .
ospec init . --summary "Internal admin portal for operations"
ospec init . --summary "Internal admin portal for operations" --tech-stack node,react,postgres
ospec init . --architecture "Single web app with API and shared auth" --document-language ar

ملاحظات CLI:

  • --summary: نص موجز للمشروع يُكتب داخل المستندات المُنشأة
  • --tech-stack: قائمة تقنيات مفصولة بفواصل مثل node,react,postgres
  • --architecture: وصف مختصر للمعمارية
  • --document-language: لغة المستندات المُنشأة، ويمكن أن تكون en-US أو zh-CN أو ja-JP أو ar
  • في محادثات AI تكون أولوية تحديد اللغة كالتالي: اللغة المطلوبة صراحة في المحادثة -> لغة المحادثة الحالية -> لغة المشروع المحفوظة في .skillrc
  • في CLI تكون أولوية تحديد اللغة كالتالي: --document-language الصريح -> لغة المشروع المحفوظة في .skillrc -> وثائق المشروع الحالية / .ospec/for-ai/* أو for-ai/* القديم / asset manifest -> الرجوع إلى en-US
  • يحفظ OSpec لغة مستندات المشروع المختارة داخل .skillrc ويعيد استخدامها في إرشادات for-ai وفي ospec new و ospec update
  • تستخدم المشاريع الجديدة التي تُهيَّأ عبر ospec init تخطيط nested افتراضيا: يبقى في الجذر فقط .skillrc و README.md بينما تنتقل بقية ملفات OSpec المُدارة إلى .ospec/
  • لا ينشئ init العادي خرائط معرفة اختيارية مثل .ospec/knowledge/src/ أو .ospec/knowledge/tests/ بشكل افتراضي
  • ما زال CLI يقبل الاختصارات مثل changes/active/<change-name>، لكن المسار الفعلي في المشاريع nested هو .ospec/changes/active/<change-name>
  • إذا مرّرت هذه القيم فسيستخدمها OSpec مباشرةً عند توليد مستندات المشروع
  • إذا لم تمرّرها فسيعيد OSpec استخدام المستندات الموجودة إن أمكن، وإلا فسينشئ مستندات أولية كعناصر نائبة

2. إنشاء تغيير ودفعه إلى الأمام

استخدم هذا النمط لتسليم المتطلبات وتحديثات المستندات وعمليات إعادة الهيكلة وإصلاحات الأخطاء.

البرومبت الموصى به:

OSpec، أنشئ تغييرًا لهذا المتطلب وادفعه إلى الأمام.

وضع المهارة في Claude / Codex:

/ospec-change أنشئ تغييرًا لهذا المتطلب وادفعه إلى الأمام.
سطر الأوامر
ospec new docs-homepage-refresh .
ospec new fix-login-timeout .
ospec new update-billing-copy .

3. الأرشفة بعد القبول

بعد أن يجتاز المتطلب النشر أو الاختبارات أو QA أو أي فحوص قبول أخرى، قم بأرشفة التغيير الذي تم التحقق منه.

البرومبت الموصى به:

OSpec، أرشف هذا التغيير المقبول.

وضع المهارة في Claude / Codex:

/ospec أرشف هذا التغيير المقبول.
سطر الأوامر
ospec verify changes/active/<change-name>
ospec finalize changes/active/<change-name>

ملاحظات الأرشفة:

  • نفّذ أولاً عملية النشر والاختبار وQA الخاصة بمشروعك
  • استخدم ospec verify للتأكد من أن التغيير الحالي جاهز للأرشفة
  • استخدم ospec finalize لإعادة بناء الفهارس وأرشفة التغيير المعتمد
  • تُؤرشف المشاريع الجديدة ذات تخطيط nested تحت .ospec/changes/archived/YYYY-MM/YYYY-MM-DD/<change-name>، وما زالت الاختصارات من نوع changes/archived/... تعمل من CLI
  • تقوم ospec update بإعادة تنظيم الأرشيفات المسطحة القديمة

طريقة تثبيت الإضافات

  • ospec plugins list
  • ospec plugins install <plugin>
  • ospec plugins enable <plugin> [path]
  • إذا قال المستخدم في المحادثة "افتح Stitch / Checkpoint" فالمقصود هو: افحص أولاً هل الإضافة مثبتة عالمياً، وإذا لم تكن مثبتة فثبّتها، ثم فعّلها داخل المشروع الحالي

الوثائق

الوثائق الأساسية

هيكل المستودع

dist/                       Compiled CLI runtime
assets/                     Managed protocol assets, hooks, and skill payloads
docs/                       Public documentation
scripts/                    Release and installation helpers
.ospec/templates/hooks/     Hook templates shipped with the package

الترخيص

هذا المشروع مرخّص بموجب MIT License.