مرجع واجهة سطر الأوامر
مرجع واجهة سطر الأوامر لـ Apothem — موجز كل أمر، وخياراته، ورموز خروجه لواجهة سطر الأوامر apothem.
تدير واجهة سطر الأوامر apothem إعدادات محوّلات أُطُر العمل انطلاقًا من
الملف التعريفي المشترك. توثّق كل صفحة أدناه أمرًا فرعيًا واحدًا: موجزه، وخياراته،
وسلوكه، ورموز خروجه.
يقبل كلٌّ من install وupdate وuninstall أيضًا
اسمًا مستعارًا بصيغة الاستمرار (installing، updating،
uninstalling) مطابقًا للأمر الأساسي في الرايات والسلوك. أمّا التحديث
وإلغاء التثبيت عبر قنوات التثبيت — إضافة Claude Code، وnpx،
وسكربتات المُثبِّت ذات الخطوة الواحدة — فموثّقان في دليلَي التثبيت
التحديث وإلغاء التثبيت، لا
عبر الأسماء المستعارة نفسها.
الأوامر
| الأمر | الوصف |
|---|---|
| quickstart | تشغيل أوّل موجَّه: يضمن وجود ملف تعريفي، ويعاين عمليات الكتابة، ثم يثبّت. |
| install | يثبّت إعداد محوّل إطار عمل من الملف التعريفي المشترك (الاسم المستعار: installing). |
| update | يعيد تثبيت إعداد محوّل إطار عمل من الملف التعريفي المشترك الحالي (الاسم المستعار: updating). |
| uninstall | يزيل إعداد محوّل إطار عمل (الاسم المستعار: uninstalling). |
| rollback | يستعيد إطار عمل إلى الحالة التي سبقت تثبيته المُسجَّل. |
| backups | يقلّم النسخ الاحتياطية للتثبيت وسجلّ الدفتر اللذين يحتفظ بهما Apothem (backups prune). |
| verify | يتحقّق من تثبيت محوّل إطار عمل. |
| status | يُبلغ عن حالة التثبيت والتحقّق والانحراف لكل إطار عمل مُسجَّل. |
| diff | يعاين تغييرات الإعداد المعلّقة لإطار عمل واحد. |
| harnesses | يسرد محوّلات أُطُر العمل المُسجَّلة ويفحصها. |
| profile | يدير الملف التعريفي المشترك لـ Apothem. |
| migrate-workspace | يرحّل مساحة عمل قديمة خاصة بكل إطار عمل إلى تخطيط .apothem المشترك. |
| doctor | يشغّل تشخيصات النظام لتثبيت Apothem. |
| completion | يُصدِر سكربت إكمال للصدفة قابلًا للتحميل بالأمر source (bash، zsh، fish، powershell). |
عقد مخرجات JSON
يقبل كل أمر باستثناء completion (الذي يُصدِر سكربت صدفة)
--json (اختصارًا لـ --format json) ويكتب حينئذٍ
مستند JSON واحدًا بالضبط إلى stdout. يبدأ كل مستند بمفتاح
schema_version في المستوى الأعلى، وهو عدد صحيح قيمته اليوم
1:
{"schema_version": 1, "status": "success", "command": "verify", "...": "..."}- الثبات. ضمن قيمة
schema_versionواحدة، تكون التغييرات إضافية فقط: يمكن أن يظهر مفتاح جديد، لكن لا يُعاد تسمية أي مفتاح ولا يُزال، ولا يتغيّر نوع أي قيمة. وأي تغيير آخر يرفعschema_version. - المُنتَجات المُرقَّمة بالنسخ. يُصدِر
profile show --jsonالملف التعريفي نفسه، لذا فإنschema_versionفيه هو نسخة مخطط الملف التعريفي (وهي1اليوم أيضًا). - استثناء واحد. يُصدِر
harnesses list --jsonمصفوفة JSON (كائنًا واحدًا لكل إطار عمل)، كما فعل دائمًا، لذا لا يملك مفتاحًا في المستوى الأعلى يحمل النسخة. وتغليفه في كائن سيكسر المحلّلات الموجودة؛ وإلى أن يفعل ذلك رفعٌ للنسخة، تعامَل مع شكله بوصفهschema_version1. - الأخطاء. تستخدم الإخفاقات المتوقّعة شكل المستند نفسه مع
"status": "error"وكائنerrorيحملcodeوfieldوreasonوfix.
رموز الخروج
تستخدم الأوامر كلها المجموعة الصغيرة نفسها من رموز الخروج؛ وتسرد كل صفحة الرموز التي يمكن أن يُرجعها أمرها.
| الرمز | المعنى |
|---|---|
| 0 | نجاح |
| 1 | إخفاق متوقّع: خطأ في التحقّق، أو الملف التعريفي، أو إطار العمل، أو المشروع، أو المحوّل |
| 2 | نتيجة جزئية: كتبت دفعةٌ شيئًا أو أزالته قبل وقوع إخفاق (فقط الأوامر التي تسرده صفحاتها) |
| 64 | خطأ استخدام: خيار أو أمر غير معروف، أو خيار مطلوب مفقود، أو قيمة خيار غير صالحة |
لا يمسّ خطأ الاستخدام نظام الملفات أبدًا. ومع --json (أو
--format json) يطبع مستند خطأ واحدًا يحمل
"code": "cli.usage" بدلًا من نص الاستخدام العادي، كي تميّز الأتمتة بين
راية مكتوبة خطأً وكتابة جزئية.
للاطلاع على أوامر الشرطة المائلة والنظرة العامة الأعلى مستوى على واجهة سطر الأوامر، راجع صفحتَي المرجع نظرة عامة على واجهة سطر الأوامر وأوامر الشرطة المائلة.
انضباط الخطط — ذاكرة عمل عابرة محلية للمشروع
إدارة ذاكرة عمل عابرة محلية للمشروع في .apothem/plans/ (تُرقَّى شجرة .plans/ القديمة عبر apothem migrate-workspace) مع مخطط الواجهة الأمامية وانتقالات دورة الحياة والترقية إلى سجلات قرار معمارية والفرض عبر الخطافات والمُتحقِّقات.
quickstart
مرجع واجهة سطر الأوامر لأمر التشغيل الأوّل الموجَّه apothem quickstart.