CLI संदर्भ
Apothem CLI संदर्भ — 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 | एक सोर्स-योग्य शेल-कम्प्लीशन स्क्रिप्ट उत्सर्जित करें (bash, zsh, fish, powershell)। |
JSON आउटपुट अनुबंध
completion (जो एक शेल स्क्रिप्ट उत्सर्जित करता है) को छोड़कर हर कमांड --json
(--format json का संक्षिप्त रूप) स्वीकार करता है और तब stdout पर ठीक एक JSON दस्तावेज़ लिखता है। प्रत्येक दस्तावेज़ एक शीर्ष-स्तरीय
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" के साथ एक त्रुटि
दस्तावेज़ प्रिंट करती है, ताकि स्वचालन किसी गलत टाइप किए गए फ़्लैग और आंशिक
लेखन में अंतर कर सके।
स्लैश कमांड और उच्च-स्तरीय CLI अवलोकन के लिए, CLI अवलोकन और स्लैश कमांड संदर्भ पृष्ठ देखें।
प्लान अनुशासन — प्रोजेक्ट-स्थानीय क्षणभंगुर वर्किंग मेमोरी
.apothem/plans/ में (पुराना .plans/ ट्री apothem migrate-workspace के माध्यम से अपग्रेड होता है) प्रोजेक्ट-स्थानीय क्षणभंगुर वर्किंग मेमोरी को frontmatter स्कीमा, जीवनचक्र संक्रमण, ADR में पदोन्नति, और हुक तथा वैलिडेटरों के माध्यम से प्रवर्तन के साथ प्रबंधित करें।
quickstart
apothem quickstart निर्देशित पहले-रन कमांड के लिए CLI संदर्भ।