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

تشغيل واجهة سطر الأوامر

تتصل واجهة سطر الأوامر twenty بمساحات عمل Twenty من طرفيتك. استخدمها لفحص البيانات الوصفية، وقراءة السجلات، وإرسال طلبات API، وإنشاء التطبيقات ومزامنتها وتصحيح أخطائها. تتطلب واجهة سطر الأوامر نفسها Node.js 24.5+. يتطلب تطوير التطبيقات أيضًا إصدار Node تدعمه SDK المثبتة، راجع البدء السريع. شغّل أي أمر عبر npx، من دون تثبيت عام:
أو ثبّتها مرة واحدة على مستوى النظام واستدعِ twenty مباشرةً:
تستخدم الأمثلة أدناه twenty. استبدل twenty بـ npx twenty@latest إذا لم تثبّته بشكل عام. شغّل twenty commands للاطلاع على قائمة الأوامر الكاملة، وtwenty \<command> --help للاطلاع على خيارات أمر واحد. يقبل كل أمر يتصل بمساحة عمل --remote \<name> لاستهداف اتصال محفوظ غير الاتصال الافتراضي، و--json للحصول على مخرجات منظَّمة.

الاتصال بمساحة عمل

سجّل الدخول باستخدام متصفحك. يجعل --use هذا الاتصال هو الاتصال الافتراضي:
استخدم عنوان مساحة العمل الخاصة بك، أو عنوان الخادم لإعداد محلي: http://localhost:2020 لـ بيئة التطوير المحلية، وhttp://localhost:3000 لنسخة مصدر مُستخرجة. يمكنك نسخ الأمر الدقيق من الإعدادات > المطورون > CLI. يتطلب تسجيل الدخول عبر المتصفح Twenty 2.42 أو إصدارًا أحدث. احتفظ بعدة اتصالات عبر تسميتها:
في CI أو البرامج النصية، مرّر مفتاح API عبر أنبوب بدلًا من تسجيل الدخول باستخدام المتصفح:
يمكنك أيضًا تعيين TWENTY_API_URL وTWENTY_API_KEY لتشغيل واحد دون حفظ أي شيء. توجد الاتصالات المحفوظة في ~/.twenty/config.json. تختار الأوامر مساحة عمل بهذا الترتيب:
  1. --remote \<name> صريح، يتجاوز متغيرات بيئة الهدف.
  2. TWENTY_REMOTE، أو الزوج TWENTY_API_URL وTWENTY_API_KEY. لا تجمع بين هاتين الطريقتين.
  3. الاتصال البعيد الافتراضي المحفوظ.
يحفظ auth login --name \<name> اتصالًا، لكنه يحتفظ بالاتصال الافتراضي الحالي. أضف --use، أو شغّل twenty remote use \<name>، لتغيير الإعداد الافتراضي.

استكشاف بياناتك

أسماء الكائنات هي أسماء API دقيقة، بصيغة المفرد أو الجمع (company أو companies). تعمل عمليات الكتابة الأولية عبر API دون خطوة تأكيد، وتظل أذوناتك في مساحة العمل سارية.

بناء تطبيق

  • يكتب app init مشروعًا جديدًا من القالب. لا يثبّت التبعيات ولا يتصل بمساحة عمل.
  • يبني app apply --create التطبيق ويسجّله في مساحة العمل ويثبّته ويزامن بياناته الوصفية.
  • يراقب app dev مصدرك ويزامن كل عملية بناء ناجحة.
أوامر التطبيقات الأخرى: تُحذف التعريفات المفقودة من مصدرك من مساحة العمل افتراضيًا. مرّر --no-prune للاحتفاظ بها. يحتفظ بها تطبيق Custom لمساحة العمل ما لم تمرّر --prune. يؤدي حذف الكائنات أو الحقول إلى حذف بياناتها أيضًا، لذا يتطلب تأكيدًا. راجع المزامنة والاستعادة للتفاصيل.

تنفيذ الدوال

شغّل دالة منطقية منشورة دون تشغيلها عبر مسار أو cron أو حدث قاعدة بيانات. زامن تغييراتك المحلية باستخدام app apply أو app dev أولًا.
يتطلب تنفيذ الدوال تسجيل الدخول عبر المتصفح. لا يمكن لمفاتيح API تنفيذها.

مراقبة سجلات الدوال

بث مخرجات الدوال المنطقية لتطبيقك عند انتهاء عمليات التنفيذ:
يعرض عمليات التنفيذ الجديدة فقط، وليس السابقة.

إلغاء تثبيت تطبيق

يشغّل هذا خطاف إلغاء تثبيت التطبيق ويحذف كل ما يملكه، بما في ذلك كائناته وحقوله وبياناتها. يبقى التطبيق مسجّلًا، لذا يمكن لـ twenty app apply تثبيته مجددًا.

تشخيص المشكلات

يتحقق doctor من إصدار Node لديك، ومن ملف twenty الثنائي الموجود في PATH لديك، واتصالاتك المحفوظة وSDK التطبيق، ثم يبلّغك بما يجب إصلاحه.

البرامج النصية والاختبارات

ناتج البناء يخص واجهة سطر الأوامر. لا تقرأ .twenty/output/manifest.json ولا تستورد رمز البناء الداخلي؛ اقرأ data.manifest من twenty app build --json.

المرجع الكامل

يغطي مرجع الأوامر كل علامة وأذن وتنسيق مخرجات ورمز خروج.