quickstart
مرجع واجهة سطر الأوامر لأمر التشغيل الأوّل الموجَّه apothem quickstart.
تشغيل أوّل موجَّه: يضمن وجود ملف تعريفي، ويعاين عمليات الكتابة، ثم يثبّت.
الموجز
apothem quickstart [--harness NAME|all] [--project PATH] [--profile PATH]
[--yes] [--quiet|-q] [--verbose|-v]
[--format plain|json] [--json] [--no-color]quickstart هو نقطة الدخول الموجَّهة الوحيدة للمُشغِّل الجديد. ففي تدفّق
خطّي واحد: (1) يضمن وجود ملف تعريفي مشترك — فيُنشئ ملفًا تعريفيًا مبدئيًا مع تنبيه
يحثّ على تخصيصه إن لم يعثر على أي ملف؛ (2) يعاين الملفات الفعلية التي ستكتبها أُطُر
العمل المختارة، مُجمَّعةً بحسب جذر المشروع مقابل دليلك المنزلي؛ (3) يطلب التأكيد؛
(4) يثبّت مع مخرجات ملاحظات القدرات المُجمَّعة والمُنقّاة من الضجيج؛ و(5) يطبع
الأوامر التالية الموصى بها.
وهو يركّب اللبنات نفسها التي يستخدمها الأمر install — ولا يعيد تنفيذها.
القيمة الافتراضية لـ --project هي الدليل الحالي. أمّا
--harness فلا قيمة افتراضية له: عند إغفاله، يسأل quickstart
عن إطار العمل المراد تثبيته، فيكتب التشغيل الأوّل إعداد إطار عمل واحد.
و--harness all يثبّت كل إطار عمل مدعوم، وهو دائمًا اختيار صريح.
السلوك
- إطار العمل — دون
--harness، يسرد التشغيل التفاعلي الأسماء المدعومة (إضافةً إلىall) ويطلب اختيار واحد منها قبل كتابة أي شيء. أما التشغيل الذي لا يستطيع السؤال —--yes، أو--format json، أو غياب الطرفية — فيتوقّف بخطأ استخدام يسمّي الخيار--harness، ولا يكتب شيئًا. - الملف التعريفي — إذا لم يوجد ملف في مسار الملف التعريفي المُحَلّ، يعرض
quickstartإنشاء ملف تعريفي مبدئي (ويُنشئه تلقائيًا مع--yes، أو في صدفة غير تفاعلية، أو مع--format json)، ويسمّي حقول الهوية النائبة التي ينبغي تخصيصها. - المعاينة + التأكيد — بالنسبة إلى
--harness all، تُسرَد الأهداف تحت عنوانين (جذر المشروع مقابل دليلك المنزلي)، ويطلب التشغيل التفاعلي التأكيد قبل الكتابة خارج المشروع. ويُثبَّت إطار عمل واحد محدَّد دون معاينة أو مطالبة. ويمضي كلٌّ من--yes، والصدفة غير التفاعلية، و--format jsonدون مطالبة. ورفض معاينة--harness allيُلغي التثبيت قبل كتاباته، أما الملف التعريفي المبدئي الذي أُنشئ في الخطوة 1 فيبقى محفوظًا. - التثبيت — تُلخَّص القدرات التي لا يدعمها إطار العمل أصليًا في ملاحظة مُجمَّعة واحدة لكل إطار عمل (مرِّر
--verboseللتفصيل لكل قدرة)؛ وتوجد المجموعة الكاملة دائمًا في مصفوفة التحذيرات في--format json. - الخطوة التالية — تسمّي مخرجات الطرفية الأوامر اللاحقة (
apothem verify …،apothem doctor).
الخيارات
| الخيار | الوصف |
|---|---|
--harness NAME | محوّل إطار العمل المراد تثبيته، أو all للمجموعة الشاملة للسجلّ كله. لا قيمة افتراضية: يسأل التشغيل التفاعلي؛ ويجب أن يمرّره التشغيل غير التفاعلي. |
--profile PATH | مسار ملف YAML للملف التعريفي المشترك. القيمة الافتراضية ~/.config/apothem/profile.yaml. |
--project PATH | جذر المشروع لأُطُر العمل ذات نطاق المشروع. القيمة الافتراضية هي الدليل الحالي. |
--yes | يشغّل التسلسل الموجَّه الكامل على نحو غير تفاعلي (يتخطّى كل مطالبة). |
--quiet, -q | يُخمِد المخرجات المعلوماتية؛ لا تُصدَر إلا الأخطاء. |
--verbose, -v | يطبع تعليل كل قدرة غير مُسقَطة بدلًا من الملاحظة المُجمَّعة. |
--format plain|json | صيغة المخرجات (الافتراضي: plain). |
--json | اختصار لـ --format json. |
--no-color | يعطّل رموز ألوان ANSI في المخرجات. |
-h, --help | يعرض المساعدة ويخرج. |
مخرجات JSON
يُصدِر --format json مستندًا واحدًا يلخّص كل خطوة موجَّهة:
{
"schema_version": 1,
"status": "success",
"command": "quickstart",
"profile_path": "C:\\Users\\Example\\.config\\apothem\\profile.yaml",
"steps": [
{"step": "profile", "outcome": "created", "path": "…", "placeholder_identity": ["name", "email", "github"]},
{"step": "install", "status": "success", "harness": "all", "files_written": ["…"], "warnings": [], "results": []},
{"step": "recommend", "next": ["apothem verify --harness all --project .", "apothem doctor"]}
],
"recommended_next": ["apothem verify --harness all --project .", "apothem doctor"]
}أمثلة
apothem quickstart # asks which harness
apothem quickstart --harness claude-code --yes
apothem quickstart --harness all --project . --yes # every harness, explicitly
apothem quickstart --harness claude-code --jsonرموز الخروج
| الرمز | المعنى |
|---|---|
| 0 | اكتمل التشغيل الموجَّه |
| 1 | خطأ متوقّع في التحقّق، أو الملف التعريفي، أو إطار العمل، أو المشروع، أو المحوّل |
| 2 | تجسيد جزئي للدفعة بعد عملية كتابة واحدة على الأقل |
| 64 | خطأ استخدام: خيار أو أمر غير معروف، أو قيمة خيار مفقودة أو غير صالحة. ومع --json يكون الخطأ غلاف JSON يحمل الرمز cli.usage. |
انظر أيضًا
- apothem install — تجسيد إطار عمل من الملف التعريفي المشترك
- apothem verify — تأكيد أن التثبيت فعّال
- apothem doctor — سلامة البيئة والتثبيت
- البدء — دليل التثبيت الكامل