الانتقال إلى المحتوى الرئيسي

Documentation Index

Fetch the complete documentation index at: https://docs.nudgen.net/llms.txt

Use this file to discover all available pages before exploring further.

​
نظرة عامة

تم تصميم Nudgen CLI بنهج يعتمد على الذكاء الاصطناعي أولاً (AI-First). بينما يوفر واجهة TUI جميلة للبشر، فإن كل أمر مُحسّن أيضاً للتواصل بين الآلات.

​
النمط الوكيلي (Agentic Pattern)

عندما يستخدم وكيل ذكاء اصطناعي (مثل Claude أو GPT أو وكيل أتمتة متخصص) واجهة CLI، يجب أن يتبع هذه الأنماط:
  1. مخرجات JSON: أضف --json إلى كل أمر للحصول على بيانات قابلة للتحليل آلياً.
  2. الوعي بالسياق: تحقق دائماً من سياق الفريق قبل إجراء العمليات.
  3. غير تفاعلي: استخدم الأعلام (flags) لتجاوز مطالبات TUI التفاعلية.

​
أتمتة JSON

يدعم كل أمر قائمة وحالة علم --json. يؤدي هذا إلى إرجاع بنية JSON نظيفة بدلاً من جدول منسق. 
# الحصول على جميع الحملات بتنسيق JSON
nudgen campaigns list --json

# الحصول على جهات الاتصال في الفريق الحالي
nudgen contacts list --json

​
سير العمل متعدد المستأجرين للوكلاء

بما أن Nudgen يدعم فرقاً متعددة، يجب على الوكيل التأكد من أنه يعمل على الفريق الصحيح قبل إنشاء أو تحديث الموارد. سير العمل الموصى به:
  1. التحقق من الفريق الحالي: 
    nudgen teams current --json
  2. تبديل الفريق (إذا لزم الأمر): إذا كان id من الخطوة السابقة لا يتطابق مع الفريق المستهدف، فقم بالتبديل: 
    nudgen teams switch <target-team-id>
  3. تنفيذ أمر البيانات: تابع باستخدام أوامر campaigns أو contacts أو brand.

​
أفضل الممارسات لمطوري الوكلاء

  • معالجة الأخطاء: راقب رمز الخروج لأوامر CLI. يشير رمز الخروج غير الصفري إلى وجود خطأ (في التحقق أو الشبكة أو المصادقة).
  • تحديد معدل الطلبات: يتواصل CLI مع واجهة برمجة تطبيقات Nudgen. تأكد من أن نصوص الوكيل البرمجية الخاصة بك تتعامل مع حدود المعدل المحتملة بسلاسة.
  • الوضع الصامت: إذا كان الأمر لا يدعم علامة محددة لكل مطالبة، فتأكد من أن وكيلك يمكنه التعامل مع تدفقات stdout/stderr دون أن يعلق في حلقة TUI.