CLI

السكربتات

قُد CLI من سكربتات shell وCI ووكلاء البرمجة بمخرجات JSON ورموز خروج ثابتة ومن دون مطالبات.

بُني CLI ليُقاد من سكربتات shell ومهام CI ووكلاء البرمجة. تذهب البيانات إلى stdout، وكل شيء آخر إلى stderr، ورموز الخروج ثابتة، ويمكن إيقاف كل مطالبة.

المخرجات

المخرجات نص حين يكون stdout طرفية وJSON حين يُوجَّه عبر أنبوب أو يُعاد توجيهه؛ أجبر صيغة بـ --output json أو --output text، أو المتغير POLYLANE_OUTPUT، أو ملف الإعدادات، بهذا ترتيب الأسبقية. لا يحمل stdout إلا البيانات، سواء كانت JSON أو صفوف جدول أو رموزاً متدفقة، فتوجيهه عبر أنبوب آمن. ويحمل stderr مؤشرات الدوران والتقدم والتلميحات والأخطاء، وفي وضع JSON يصل الخطأ كائناً بـ code وmessage وhint، حيث يطابق code رمز الخروج.

أعلام للسكربتات

العلمالوصف
--output jsonإجبار JSON بصرف النظر عن حالة الطرفية
--quietكبت مؤشرات الدوران والتقدم؛ يبقى stdout بيانات خالصة
--non-interactiveالفشل السريع عند نقص المدخلات بدلاً من المطالبة
--yesتجاوز التأكيد في الأوامر المدمّرة
--dry-runعرض ما سيحدث من دون إجراء تغييرات
--fullإرجاع الكائنات الكاملة في أوامر السرد بدلاً من إسقاط الحقول الضيق
--api-key <key>تجاوز مفتاح API المخزّن لاستدعاء واحد
--workspace <id>تجاوز مساحة العمل الافتراضية لاستدعاء واحد

مع --non-interactive، يرفض polylane cloud disconnect العمل ما لم تمرّر --yes أيضاً، بينما تُتجاوز التأكيدات الأخرى، مثل polylane memory delete، فمرّر --yes صراحةً لتوضيح النية. يضبط POLYLANE_API_KEY وPOLYLANE_WORKSPACE_ID بيانات الاعتماد ومساحة العمل من البيئة، وهذا يلائم CI؛ انظر المصادقة.

رموز الخروج

الرمزالوصف
0نجاح
1خطأ عام
2خطأ في الاستخدام: علم سيئ، أو وسيط ناقص
3خطأ في المصادقة
4تحديد معدل أو الحاجة إلى ترقية الخطة
5انتهاء المهلة
6خطأ في الشبكة
130مقاطعة بـ Ctrl-C

تفرّع على رمز الخروج أولاً لتقرير ما إذا كنت ستعيد المحاولة أو تعيد المصادقة أو تُظهر الفشل، ثم حلّل كائن الخطأ على stderr للتفاصيل.

مثال

Terminal
polylane issue list --active --severity critical --output json --quiet \
  | jq -r '.items[] | "\(.id)\t\(.title)"'

يعيد polylane issue list كائناً بـ items وcount، ويُسقَط كل عنصر إلى id وseverity وstatus وtitle وresourceKind وresourceId وdetectedAt وinvestigationThreadId؛ ويعيد --full الكائنات الكاملة. تشرح المشكلات دورة الحياة التي خلف كل حالة.

ذات صلة

  • المصادقة: مفاتيح API ومتغيرات البيئة لـ CI.
  • الإعدادات: إعدادات المخرجات والمهلة وملف الإعدادات.
  • المشكلات: الحالات ودرجات الخطورة التي تعيدها أوامر issue.
  • Threads: ما يبدأه thread ask وكيف تتقدم المحادثة.