CLI संदर्भ
doctor
apothem doctor कमांड के लिए CLI संदर्भ।
जो इंस्टॉल है उसके स्वास्थ्य की जाँच करें। जहाँ
apothem verify आपके चुने हुए हार्नेसों की जाँच
करता है, वहाँ doctor हर इंस्टॉल किए गए हार्नेस और साझा प्रोफ़ाइल की एक ही पास
में जाँच करता है।
सारांश
apothem doctor [--project PATH] [--quiet|-q] [--verbose|-v]
[--format plain|json] [--json] [--no-color]यह क्या जाँचता है
- साझा प्रोफ़ाइल। मौजूद प्रोफ़ाइल को पैकेज किए गए स्कीमा के विरुद्ध सत्यापित
किया जाता है; विकृत प्रोफ़ाइल अपने निदान कोड के साथ विफल होती है। लुप्त
प्रोफ़ाइल की रिपोर्ट की जाती है, उसे विफल नहीं माना जाता (
installएक प्रोफ़ाइल बनाता है)। - केवल इंस्टॉल किए गए हार्नेस। जो हार्नेस इंस्टॉल नहीं है उसकी रिपोर्ट
not_installedके रूप में की जाती है और वह विफलता नहीं है, इसलिए एक स्वस्थ हार्नेस वाली मशीन पास हो जाती है। प्रोजेक्ट-स्कोप हार्नेसों की जाँच तब होती है जब--projectउनका रूट नामित करता है; इसके बिना उनकी रिपोर्टneeds_projectके रूप में की जाती है। - सत्यापन। प्रत्येक इंस्टॉल किए गए हार्नेस को वही जाँच पास करनी होगी जो
verifyकरता है। - हुक रनटाइम। प्रत्येक सत्यापित हार्नेस के लिए, doctor वे फ़ाइलें पढ़ता है
जो उसके नवीनतम इंस्टॉल ने लिखीं, वहाँ Apothem द्वारा पंजीकृत हुक कमांड खोजता
है, और प्रत्येक इंटरप्रेटर और हुक स्क्रिप्ट को एक no-op पेलोड के साथ एक बार
शुरू करता है (पंजीकृत आर्ग्युमेंट और उनके साथ
--help, stdin पर{}, एक अस्थायी वर्किंग डायरेक्टरी, औरPYTHONPATHहटाया हुआ)। कुछ भी नहीं लिखा जाता। लुप्त इंटरप्रेटर, लुप्त स्क्रिप्ट, या इम्पोर्ट के समय क्रैश जाँच को विफल कर देता है।
हर विफल जाँच एक समाधान नामित करती है। कोई जाँच विफल न होने पर 0 के साथ बाहर निकलता है, अन्यथा 1 के साथ।
JSON आउटपुट
--json पहले वाले फ़ील्ड (version, python, platform,
profile_path, profile_exists, profile_valid, harnesses, all_ok,
और प्रोफ़ाइल अमान्य होने पर profile_error) बनाए रखता है और ये जोड़ता है:
profile_error_code— प्रोफ़ाइल निदान कोड, जब प्रोफ़ाइल अमान्य हो।project— हल किया गया--projectरूट, याnull।harnesses[].status—ok,not_installed,needs_project,verify_failed,hook_failed, याerror; साथ मेंverifiedऔरhooks({"probed": N, "failed": [...]}, या कोई इंस्टॉल रिकॉर्ड मौजूद न होने परnull)।checks— प्रति जाँच एक रिकॉर्ड:code(उदाहरण के लिएharness.verify_failed,hook.start_failed,ledger.unreadable, या कोईprofile.*कोड),status(pass,fail, याinfo),harness,message, औरfix।
{
"schema_version": 1,
"all_ok": false,
"checks": [
{
"code": "hook.start_failed",
"status": "fail",
"harness": "claude-code",
"message": "claude-code: a registered hook command cannot start: …",
"fix": "Check that the interpreter in the hook command exists and runs, then …"
}
]
}विकल्प
| विकल्प | विवरण |
|---|---|
--project PATH | प्रोजेक्ट-स्कोप हार्नेसों के लिए प्रोजेक्ट रूट; इसके बिना उनकी रिपोर्ट needs_project के रूप में की जाती है। |
--quiet, -q | सूचनात्मक आउटपुट दबाएँ; केवल त्रुटियाँ उत्सर्जित होती हैं। |
--verbose, -v | अन्य कमांडों के साथ संगति के लिए स्वीकार किया जाता है; यह कमांड कोई अतिरिक्त आउटपुट प्रिंट नहीं करता। |
--format plain|json | आउटपुट प्रारूप (डिफ़ॉल्ट: plain)। |
--json | --format json का संक्षिप्त रूप। |
--no-color | आउटपुट में ANSI रंग कोड अक्षम करें। |
-h, --help | सहायता दिखाएँ और बाहर निकलें। |
उदाहरण
apothem doctor
apothem doctor --project .
apothem doctor --jsonडिफ़ॉल्ट plain प्रारूप मानव-पठनीय निदान प्रिंट करता है; --json
(--format json के समतुल्य) stdout पर एक मशीन-पठनीय दस्तावेज़ उत्सर्जित करता है,
जो अन्य टूलिंग में पाइप करने के लिए उपयुक्त है।
निकास कोड
| कोड | अर्थ |
|---|---|
| 0 | सभी जाँचें पास हुईं (तब भी जब अभी तक कोई हार्नेस इंस्टॉल नहीं है) |
| 1 | कोई इंस्टॉल किया गया हार्नेस सत्यापित नहीं होता, कोई पंजीकृत हुक कमांड शुरू नहीं हो सकता, कोई अडैप्टर लोड या प्रोब नहीं किया जा सका, या कोई मौजूद प्रोफ़ाइल स्कीमा सत्यापन में विफल रही |
| 64 | उपयोग त्रुटि: कोई अज्ञात विकल्प या कमांड, या कोई लुप्त या अमान्य विकल्प मान। --json के अंतर्गत त्रुटि cli.usage कोड वाला एक JSON एनवेलप होती है। |
यह भी देखें
- apothem harnesses — पंजीकृत हार्नेसों को सूचीबद्ध करें और उनका निरीक्षण करें
- apothem verify — किसी हार्नेस अडैप्टर इंस्टॉलेशन को सत्यापित करें