Skip to content
Apothem
CLI संदर्भ

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 कमांड करता है — यह उन्हें फिर से लागू नहीं करता। --project का डिफ़ॉल्ट वर्तमान डायरेक्टरी है। --harness का कोई डिफ़ॉल्ट नहीं है: जब इसे छोड़ा जाता है, तो quickstart पूछता है कि कौन-सा हार्नेस इंस्टॉल करना है, इसलिए पहला रन एक हार्नेस का कॉन्फ़िगरेशन लिखता है। --harness all हर समर्थित हार्नेस इंस्टॉल करता है और हमेशा एक स्पष्ट चुनाव होता है।

व्यवहार

  • हार्नेस — --harness के बिना, एक इंटरैक्टिव रन समर्थित नाम (साथ में all) सूचीबद्ध करता है और कुछ भी लिखे जाने से पहले उनमें से एक के लिए पूछता है। जो रन पूछ नहीं सकता — --yes, --format json, या कोई टर्मिनल नहीं — वह --harness विकल्प का नाम बताने वाली एक उपयोग त्रुटि के साथ रुक जाता है, और कुछ भी नहीं लिखता।
  • प्रोफ़ाइल — यदि हल किए गए प्रोफ़ाइल पथ पर कोई फ़ाइल नहीं है, तो quickstart एक स्टार्टर प्रोफ़ाइल बनाने की पेशकश करता है (--yes, एक गैर-इंटरैक्टिव शेल, या --format json के अंतर्गत स्वतः बनाता है) और वैयक्तिकृत करने के लिए प्लेसहोल्डर पहचान फ़ील्ड के नाम बताता है।
  • पूर्वावलोकन + पुष्टि — --harness all के लिए, टारगेट दो शीर्षकों के अंतर्गत सूचीबद्ध होते हैं (प्रोजेक्ट रूट बनाम आपकी होम डायरेक्टरी), और एक इंटरैक्टिव रन प्रोजेक्ट के बाहर लिखने से पहले पुष्टि करवाता है। एक नामित एकल हार्नेस बिना पूर्वावलोकन या प्रॉम्प्ट के इंस्टॉल होता है। --yes, एक गैर-इंटरैक्टिव शेल, और --format json बिना प्रॉम्प्ट के आगे बढ़ते हैं। --harness all के पूर्वावलोकन को अस्वीकार करने पर इंस्टॉल लेखन से पहले रुक जाता है; चरण 1 में बनाई गई स्टार्टर प्रोफ़ाइल बनी रहती है।
  • इंस्टॉल — जिन क्षमताओं का कोई हार्नेस नेटिव रूप से समर्थन नहीं करता, उन्हें प्रति हार्नेस एक समूहबद्ध नोट के रूप में सारांशित किया जाता है (प्रति-क्षमता विवरण के लिए --verbose पास करें); पूरा सेट हमेशा --format json की warnings ऐरे में होता है।
  • अगला चरण — टर्मिनल आउटपुट अनुवर्ती कमांड के नाम बताता है (apothem verify …, apothem doctor)।

विकल्प

विकल्पविवरण
--harness NAMEइंस्टॉल करने के लिए हार्नेस अडैप्टर, या रजिस्ट्री-व्यापी सेट के लिए 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 एक एकल दस्तावेज़ उत्सर्जित करता है जो प्रत्येक निर्देशित चरण का सारांश देता है:

{
  "schema_version": 1,
  "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                                  # asks which harness
apothem quickstart --harness claude-code --yes
apothem quickstart --harness all --project . --yes  # every harness, explicitly
apothem quickstart --harness claude-code --json

निकास कोड

कोडअर्थ
0निर्देशित रन पूरा हुआ
1अपेक्षित सत्यापन, प्रोफ़ाइल, हार्नेस, प्रोजेक्ट या अडैप्टर त्रुटि
2कम से कम एक लेखन के बाद आंशिक बैच मूर्तीकरण
64उपयोग त्रुटि: एक अज्ञात विकल्प या कमांड, या एक लुप्त या अमान्य विकल्प मान। --json के अंतर्गत त्रुटि cli.usage कोड वाला एक JSON एनवेलप होती है।

यह भी देखें

  • apothem install — साझा प्रोफ़ाइल से एक हार्नेस को मूर्त रूप दें
  • apothem verify — पुष्टि करें कि एक इंस्टॉलेशन सक्रिय है
  • apothem doctor — परिवेश और इंस्टॉलेशन का स्वास्थ्य
  • आरंभ करना — पूर्ण इंस्टॉलेशन गाइड

On this page