CLI संदर्भ
Apothem CLI संदर्भ — सभी उपकमांड और फ़्लैग।
apothem CLI साझा प्रोफ़ाइल और हार्नेस अडैप्टरों के प्रबंधन के लिए प्राथमिक
ऑपरेटर इंटरफ़ेस है।
ग्लोबल फ़्लैग
| फ़्लैग | विवरण |
|---|---|
--version | Apothem संस्करण प्रिंट करें और बाहर निकलें |
--help | कमांड के लिए सहायता प्रिंट करें |
उपकमांड
apothem install
साझा प्रोफ़ाइल से एक हार्नेस अडैप्टर इंस्टॉल करें।
apothem install --harness <name|all> [--profile PATH] [--project PATH] [--dry-run] [--clean|--fresh] [--yes]| विकल्प | विवरण |
|---|---|
--harness <name> | हार्नेस अडैप्टर का नाम (नीचे विहित मान देखें)। आवश्यक। |
--profile PATH | साझा प्रोफ़ाइल YAML का पथ। डिफ़ॉल्ट ~/.config/apothem/profile.yaml है। |
--project PATH | प्रोजेक्ट-दायरे वाले हार्नेसों के लिए प्रोजेक्ट रूट। |
--dry-run | फ़ाइलें लिखे बिना इंस्टॉल का पूर्वावलोकन करें। |
--clean, --fresh | ऑप्ट-इन स्वच्छ शुरुआत: इंस्टॉल करने से पहले पिछली इंस्टॉल स्थिति (~/.claude, ~/.codex, ~/.agents, ~/.config/apothem) का बैकअप लें और उसे हटाएँ। |
--yes | स्वच्छ-शुरुआत निष्कासन के दौरान प्रति-टारगेट पुष्टि छोड़ें (गैर-इंटरैक्टिव --clean रन के लिए आवश्यक)। |
विहित --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 इंजन को
अपग्रेड नहीं करता; इंजन को उसी चैनल से अपडेट करें जिससे आपने उसे इंस्टॉल किया था
(/plugin प्रवाह, npx, या इंस्टॉलर और अपडेट स्क्रिप्ट), जैसा कि
अपडेट करना में वर्णित है।
apothem uninstall
किसी हार्नेस अडैप्टर की नेटिव कॉन्फ़िग हटाएँ।
apothem uninstall --harness <name|all> [--project PATH] [--yes]| विकल्प | विवरण |
|---|---|
--harness <name> | हार्नेस अडैप्टर का नाम। आवश्यक। |
--project PATH | प्रोजेक्ट-दायरे वाले हार्नेसों के लिए प्रोजेक्ट रूट। |
--yes | पुष्टि संकेत छोड़ें। |
apothem verify
सत्यापित करें कि किसी हार्नेस अडैप्टर के प्रबंधित टारगेट मौजूद और वैध हैं।
apothem verify --harness <name|all> [--profile PATH] [--project PATH]| विकल्प | विवरण |
|---|---|
--harness <name> | हार्नेस अडैप्टर का नाम या all। आवश्यक। |
--profile PATH | वह साझा प्रोफ़ाइल YAML जिसके विरुद्ध निष्ठा की जाँच करनी है। इसके बिना जाँच पूरी तरह संरचनात्मक होती है। |
--project PATH | प्रोजेक्ट-दायरे वाले हार्नेसों के लिए प्रोजेक्ट रूट। |
--profile के बिना जाँच संरचनात्मक होती है: हर प्रबंधित टारगेट मौजूद और वैध
होना चाहिए। --profile के साथ यह निष्ठा भी अपेक्षित करती है, इसलिए जो इंस्टॉल
मौजूद है किंतु उस प्रोफ़ाइल से भटक गया है, वह verify में विफल होता है — किसी
विशिष्ट प्रोफ़ाइल के निष्ठापूर्वक इंस्टॉल होने की पुष्टि करने के लिए इसका उपयोग
करें।
जब हार्नेस सत्यापित होता है (और, --profile के साथ, उस प्रोफ़ाइल के प्रति
निष्ठावान होता है) तो एग्ज़िट कोड 0 होता है; जब कोई टारगेट अनुपस्थित या अमान्य
होता है, या जब --profile दिया गया हो और इंस्टॉल भटक गया हो, तो 1 होता है।
apothem status
हर पंजीकृत हार्नेस के लिए इंस्टॉल, सत्यापन और ड्रिफ़्ट स्थिति की रिपोर्ट करें।
apothem status [--profile PATH] [--project PATH]| विकल्प | विवरण |
|---|---|
--profile PATH | ड्रिफ़्ट आधार-रेखा के रूप में उपयोग की जाने वाली साझा प्रोफ़ाइल। एक अपठनीय डिफ़ॉल्ट प्रोफ़ाइल स्वीप को रद्द करने के बजाय ड्रिफ़्ट को unknown तक घटा देती है। |
--project PATH | प्रोजेक्ट-दायरे वाले हार्नेसों के लिए प्रोजेक्ट रूट। इसके बिना वे needs-project रिपोर्ट करते हैं। |
प्रत्येक पंक्ति एक installed फ़्लैग को एक verified फ़्लैग के साथ जोड़ती है,
और दोनों मिलकर ड्रिफ़्ट स्थिति बनाते हैं:
| स्थिति | अर्थ |
|---|---|
absent | Apothem ने इस हार्नेस में इंस्टॉल नहीं किया है। |
in-sync | इंस्टॉल है और प्रोफ़ाइल आधार-रेखा से मेल खाता है। |
drift | इंस्टॉल है किंतु अब मेल नहीं खाता — apothem update से सुधारें। |
unknown | इंस्टॉल है, किंतु आधार-रेखा प्रोफ़ाइल पढ़ी नहीं जा सकी। |
needs-project | एक प्रोजेक्ट-स्कोप हार्नेस --project के बिना रिपोर्ट किया गया, इसलिए उसका लक्ष्य हल नहीं किया जा सकता। |
installed इस प्रश्न का उत्तर देता है कि "क्या Apothem ने यहाँ इंस्टॉल किया?",
न कि "क्या यह हार्नेस मशीन पर मौजूद है?"। यह Apothem के अपने आर्टिफ़ैक्ट पर
आधारित है — किसी निर्देश-लंगर के भीतर का प्रबंधित ब्लॉक, और Apothem-स्वामित्व
वाले .apothem/ उप-वृक्ष के अंतर्गत की सामग्री — कभी किसी ऐसी वेंडर-स्वामित्व
वाली फ़ाइल पर नहीं जिसे हार्नेस अपने लिए लिखता है। जिस हार्नेस की कॉन्फ़िग
डायरेक्टरी मौजूद है किंतु जिसे Apothem ने कभी छुआ नहीं, वह absent रिपोर्ट करता
है, और जिसे अनइंस्टॉल किया जा चुका है वह भी absent रिपोर्ट करता है, भले ही
खाली की गई डायरेक्टरियाँ बनी रहें।
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 | हल की गई प्रोफ़ाइल को JSON के रूप में stdout पर प्रिंट करें। --json के साथ दस्तावेज़ schema_version से शुरू होता है। |
profile set <key> <value> | एक प्रोफ़ाइल फ़ील्ड सेट करें। मान एक शाब्दिक स्ट्रिंग के रूप में संग्रहीत होता है — सादे शब्दों का प्रकार-रूपांतरण नहीं होता, इसलिए no "no" ही रहता है और 1.0 स्ट्रिंग ही रहता है — सिवाय true/false और स्पष्ट [...] / {...} सूची और मैप इनपुट के। संयोजित प्रोफ़ाइल को लिखे जाने से पहले स्कीमा-सत्यापित की जाती है। |
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 doctorApothem का संस्करण, Python इंटरप्रेटर, प्लेटफ़ॉर्म, हल किया गया प्रोफ़ाइल पथ, और प्रति-हार्नेस इंस्टॉल-स्थिति तालिका प्रिंट करता है। जब कोई भी जाँच विफल हो तो एग्ज़िट कोड 1 होता है: अमान्य प्रोफ़ाइल, ऐसा इंस्टॉल किया हुआ हार्नेस जो सत्यापित न हो, पंजीकृत हुक कमांड जो शुरू न हो सके, ऐसा अडैप्टर जिसे लोड या प्रोब न किया जा सके, या न पढ़ा जा सकने वाला बही-खाता। जो हार्नेस इंस्टॉल नहीं है, वह रिपोर्ट होता है और विफलता नहीं गिना जाता, और सूचनात्मक नोट एग्ज़िट कोड नहीं बदलते।
जनित कमांड और फ़्लैग संदर्भ
| Command | Flags | Description |
|---|---|---|
apothem backups prune | --dry-run, --format, --harness, --json, --keep, --no-color, --quiet, -q, --verbose, -v | Delete backup sets and install records beyond the newest N per harness. Keeps the newest N backup sets under ~/.apothem/backups/ for each selected harness, and the newest N install records per install root in its ledger under ~/.apothem/state/. A backup set that a kept record, or the latest install record of any install root, still references is never deleted, so rollback of the latest install still restores. |
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, --project, --quiet, -q, --verbose, -v | Check the installed harnesses and the shared profile; exit 1 on any failure. Reports the engine version, Python, and platform; validates a present shared profile against the packaged schema; and, for every installed harness, runs the adapter's verify and starts each hook command the install registered with a no-op payload. A harness that is not installed is reported but is not a failure, so a machine with one healthy harness passes. Project-scope harnesses are checked when --project names their root. |
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. Without --harness it asks which harness to install, so the first run writes one harness's configuration rather than all of them; all is an explicit choice. A run that cannot ask fails with a usage error before anything is written. |
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?". |