المرجع
مرجع واجهة سطر الأوامر
مرجع واجهة سطر الأوامر في Apothem — جميع الأوامر الفرعية والرايات.
تُعَدّ واجهة سطر الأوامر apothem الواجهة الأساسية للمشغّل لإدارة
الملف التعريفي المشترك ومحوّلات أُطُر العمل.
الرايات العامة
| الراية | الوصف |
|---|---|
--version | يطبع إصدار Apothem ويخرج |
--help | يطبع تعليمات الأمر |
الأوامر الفرعية
apothem install
يُثبّت محوّل إطار عمل من الملف التعريفي المشترك.
apothem install --harness <name|all> [--profile PATH] [--project PATH] [--dry-run]| الخيار | الوصف |
|---|---|
--harness <name> | اسم محوّل إطار العمل (راجع القيم الكنسية أدناه). مطلوب. |
--profile PATH | المسار إلى YAML الملف التعريفي المشترك. الافتراضي هو ~/.config/apothem/profile.yaml. |
--project PATH | جذر المشروع لأُطُر العمل ذات نطاق المشروع. |
--dry-run | معاينة التثبيت دون كتابة ملفات. |
قيم --harness الكنسية:
antigravity
claude-code
codebuddy
codex
cursor
gemini-cli
github-copilot
glm
hermes
kimi-code
kiro
open-claw
opencode
qwen-code
trae
windsurf
zedاستخدم --harness all --project <path> لتحديد المجموعة على مستوى السجلّ
بأكمله. تُحترَم قائمة exclude_harnesses الخاصّة بالملف التعريفي أثناء
التحديد الدفعي للتثبيت/التحديث.
apothem update
يُعيد اشتقاق الإعداد الأصلي لمحوّل إطار عمل من الملف التعريفي المشترك الحالي.
apothem update --harness <name|all> [--profile PATH] [--project PATH] [--dry-run]| الخيار | الوصف |
|---|---|
--harness <name> | اسم محوّل إطار العمل. مطلوب. |
--profile PATH | المسار إلى YAML الملف التعريفي المشترك. |
--project PATH | جذر المشروع لأُطُر العمل ذات نطاق المشروع. |
--dry-run | معاينة التحديث دون كتابة ملفات. |
يُعيد update تجسيد مُخرَج إطار العمل. وهو لا يُحدِّث حزمة واجهة سطر الأوامر
لـ Apothem؛ ولترقية الحزمة، استخدم مدير الحزم الذي ثبّت Apothem.
apothem uninstall
يزيل الإعداد الأصلي لمحوّل إطار عمل.
apothem uninstall --harness <name|all> [--project PATH] [--yes]| الخيار | الوصف |
|---|---|
--harness <name> | اسم محوّل إطار العمل. مطلوب. |
--project PATH | جذر المشروع لأُطُر العمل ذات نطاق المشروع. |
--yes | تخطّي مُطالَبة التأكيد. |
apothem verify
يتحقّق من أنّ محوّل إطار العمل مُثبَّت وأنّ مسار مُخرَجه موجود.
apothem verify --harness <name|all> [--project PATH]| الخيار | الوصف |
|---|---|
--harness <name> | اسم محوّل إطار العمل أو all. مطلوب. |
--project PATH | جذر المشروع لأُطُر العمل ذات نطاق المشروع. |
رمز الخروج هو 0 عندما يكون المحوّل مُثبَّتًا، و1 عندما لا يكون كذلك.
apothem profile
يُدير الملف التعريفي المشترك لـ Apothem.
apothem profile show [--profile PATH]
apothem profile init [--profile PATH] [--force]
apothem profile set <key> <value> [--profile PATH]
apothem profile edit [--profile PATH]| الأمر الفرعي | الوصف |
|---|---|
profile init | يُنشئ هيكلًا أوّليًا لملف تعريفي مُصغّر صالح وفق المُخطّط. |
profile show | يطبع الملف التعريفي المُحلَّل (YAML) إلى stdout. |
profile set <key> <value> | يضبط حقلًا في الملف التعريفي. تُحلَّل القيمة كـ YAML (تُقبَل السلاسل النصّية والأعداد والقيم المنطقية والقوائم والخرائط جميعها). |
profile edit | يفتح الملف التعريفي في $EDITOR (مع الرجوع إلى محرّر المنصّة الافتراضي). |
يُوجِّه خيار --profile PATH كلَّ أمر فرعي إلى ملف تعريفي بديل. الافتراضي
هو ~/.config/apothem/profile.yaml.
apothem harnesses
يُدرِج محوّلات أُطُر العمل المُسجَّلة ويفحصها.
apothem harnesses list
apothem harnesses show <name>| الأمر الفرعي | الوصف |
|---|---|
harnesses list | يطبع جدولًا بكلّ محوّل مُسجَّل مع راية حالة تثبيته ومسار مُخرَجه. |
harnesses show <name> | يطبع الاسم وحالة التثبيت ومسار المُخرَج لمحوّل واحد. |
apothem doctor
يُشغّل تشخيصات النظام لتثبيت Apothem.
apothem doctorيطبع إصدار Apothem، ومُفسِّر Python، والمنصّة، ومسار الملف التعريفي المُحلَّل،
وجدول حالة التثبيت لكلّ إطار عمل. رمز الخروج هو 0 عندما يُبلِّغ كلّ محوّل مُسجَّل
بأنّه مُثبَّت؛ وإلّا فهو 1.
مرجع الأوامر والرايات المُولَّد
| Command | Flags | Description |
|---|---|---|
apothem completion | — | Print a shell-completion script for SHELL to stdout. Supported shells: bash, zsh, fish, powershell. Every script is generated by Click's env-var completion protocol — PowerShell through the completion class registered above, since Click ships none natively. Enabling completion is opt-in: this command only prints the script — pipe or append it to the shell's completion file yourself (see --help). |
apothem diff | --format, --harness, --json, --no-color, --profile, --project, --quiet, -q, --verbose, -v | Preview the pending configuration changes for a single harness. |
apothem doctor | --format, --json, --no-color, --quiet, -q, --verbose, -v | Report Apothem environment and installation health, exiting non-zero on any failure. Prints the engine version, Python, and platform, validates the shared profile against the packaged schema — a present-but-malformed profile is a failure, not a green "found" — and probes every registered adapter's install state. An adapter that raises degrades to an error row rather than aborting the sweep. Any failed check — an invalid profile, or a harness that is uninstalled or could not be probed — forces a non-zero exit so a CI or setup step can gate on it. |
apothem harnesses list | --format, --json, --no-color, --quiet, -q, --verbose, -v | List all registered harness adapters. |
apothem harnesses show | --format, --json, --no-color, --quiet, -q, --verbose, -v | Show details for a specific harness adapter. |
apothem install | --clean, --fresh, --dry-run, --format, --harness, --json, --no-color, --profile, --project, --quiet, -q, --verbose, -v, --yes | Install a harness adapter configuration. |
apothem migrate-workspace | --dry-run, --format, --json, --no-color, --project, --quiet, -q, --verbose, -v | Migrate a legacy per-harness workspace into the shared .apothem layout. The base is the resolved --project root when supplied, otherwise the current working directory (the project-local default). Per-harness memory/contexts/learning stores union-merge into the shared store; a conflicting record is skipped, never overwritten; a legacy .plans tree moves under .apothem/plans; every consumed source is backed up first. The migration is idempotent. |
apothem profile edit | --format, --json, --no-color, --profile, --quiet, -q, --verbose, -v | Open the shared profile in the system editor. |
apothem profile init | --force, --format, --json, --no-color, --profile, --quiet, -q, --verbose, -v | Create a schema-valid shared profile scaffold. |
apothem profile set | --format, --json, --no-color, --profile, --quiet, -q, --verbose, -v | Set a key in the shared profile. KEY is a dotted path that descends into the nested profile structure (identity.name, preferences.style, enforcement.sprints, harnesses.<harness>.preferences.style); a single key with no dot sets a top-level node. VALUE is stored as a literal string — bare words are not coerced (no stays "no", 2024-01-01 and 1.0 stay strings) — except true/false (the boolean enforcement flags) and explicit [...]/{...} list/map input. The fully-assembled profile is validated against the packaged schema BEFORE writing; an invalid set is refused with the standard diagnostic and the profile on disk is unchanged. |
apothem profile show | --format, --json, --no-color, --profile, --quiet, -q, --verbose, -v | Display the current shared profile. |
apothem quickstart | --format, --harness, --json, --no-color, --profile, --project, --quiet, -q, --verbose, -v, --yes | Guided first run: ensure a profile, preview the writes, then install. Walks a new operator through the canonical path in one linear flow — create a starter profile if none exists (with a personalize nudge), preview the files each harness will write (project root vs your home directory), confirm, then install with the grouped capability-note output — and ends with the recommended next commands. --yes runs the whole sequence non-interactively; --format json emits one structured summary of every step. It composes the install building blocks; it does not duplicate them. |
apothem rollback | --format, --harness, --install-id, --json, --last, --no-color, --project, --quiet, -q, --verbose, -v, --yes | Restore a harness to the state before its recorded install. |
apothem status | --format, --json, --no-color, --profile, --project, --quiet, -q, --verbose, -v | Report install, verify, and drift state for every registered harness. |
apothem uninstall | --format, --harness, --json, --no-color, --project, --quiet, -q, --verbose, -v, --yes | Remove a harness adapter configuration. |
apothem update | --dry-run, --format, --harness, --json, --no-color, --profile, --project, --quiet, -q, --verbose, -v | Re-install a harness adapter configuration from the current profile. |
apothem verify | --format, --harness, --json, --no-color, --profile, --project, --quiet, -q, --verbose, -v | Verify a harness adapter installation. Without --profile the check is structural: every managed target must be present and valid. With --profile the check additionally requires profile fidelity, so a present-but-drifted install fails verify — answering "is THIS profile faithfully installed?" rather than merely "does it exist?". |