quickstart
apothem quickstart निर्देशित पहली-बार-चलाने वाली कमांड के लिए CLI संदर्भ।
निर्देशित पहली बार चलाना: सुनिश्चित करता है कि एक प्रोफ़ाइल मौजूद है, लेखन का पूर्वावलोकन करता है, फिर इंस्टॉल करता है।
सारांश
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 कमांड करता है — यह उन्हें पुनः लागू नहीं करता। --harness का डिफ़ॉल्ट all है और --project का वर्तमान निर्देशिका।
व्यवहार
- प्रोफ़ाइल — यदि हल किए गए प्रोफ़ाइल पथ में कोई फ़ाइल नहीं है, तो
quickstartएक स्टार्टर प्रोफ़ाइल बनाने की पेशकश करता है (--yes, गैर-अंतःक्रियात्मक शेल, या--format jsonके अंतर्गत स्वतः बनाता है) और वैयक्तिकृत किए जाने वाले प्लेसहोल्डर पहचान फ़ील्ड नामित करता है। - पूर्वावलोकन + पुष्टि — किसी भी लेखन से पहले, लक्ष्य दो शीर्षकों के अंतर्गत सूचीबद्ध किए जाते हैं (परियोजना मूल बनाम आपकी होम निर्देशिका); एक अंतःक्रियात्मक रन परियोजना के बाहर लिखने से पहले पुष्टि करता है।
--yes, एक गैर-अंतःक्रियात्मक शेल, और--format jsonबिना संकेत दिए आगे बढ़ते हैं। अस्वीकार करने पर किसी भी लेखन से पहले निरस्त हो जाता है। - इंस्टॉल — जिन क्षमताओं का कोई कोडिंग-सहायक मूल रूप से समर्थन नहीं करता, उन्हें प्रति कोडिंग-सहायक एक समूहीकृत नोट के रूप में सारांशित किया जाता है (प्रति-क्षमता विवरण के लिए
--verboseपास करें); पूर्ण समुच्चय हमेशा--format jsonके warnings सरणी में होता है। - अगला चरण — टर्मिनल आउटपुट अनुवर्ती कमांड नामित करता है (
apothem verify …,apothem doctor)।
विकल्प
| विकल्प | विवरण |
|---|---|
--harness NAME | इंस्टॉल करने के लिए कोडिंग-सहायक अडैप्टर, या रजिस्ट्री-व्यापी समुच्चय के लिए all (डिफ़ॉल्ट: 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 एक एकल दस्तावेज़ उत्सर्जित करता है जो प्रत्येक निर्देशित चरण का सारांश देता है:
{
"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
apothem quickstart --harness all --project . --yes
apothem quickstart --harness claude-code
apothem quickstart --jsonएग्जिट कोड
| कोड | अर्थ |
|---|---|
| 0 | निर्देशित रन पूर्ण हुआ |
| 1 | अपेक्षित मान्यकरण, प्रोफ़ाइल, कोडिंग-सहायक, परियोजना, या अडैप्टर त्रुटि |
| 2 | कम से कम एक लेखन के बाद आंशिक बैच मूर्तिकरण |
यह भी देखें
- apothem install — साझा प्रोफ़ाइल से एक कोडिंग-सहायक मूर्त करता है
- apothem verify — पुष्टि करता है कि एक इंस्टॉलेशन सक्रिय है
- apothem doctor — परिवेश और इंस्टॉलेशन स्वास्थ्य
- आरंभ करना — पूर्ण इंस्टॉलेशन गाइड